Skip to content

Update README to include forking instructions before cloning repository#10286

Closed
pbearne wants to merge 9 commits intoWordPress:trunkfrom
pbearne:add-fork-to-readme.md
Closed

Update README to include forking instructions before cloning repository#10286
pbearne wants to merge 9 commits intoWordPress:trunkfrom
pbearne:add-fork-to-readme.md

Conversation

@pbearne
Copy link
Copy Markdown

@pbearne pbearne commented Oct 15, 2025

@github-actions
Copy link
Copy Markdown

github-actions bot commented Oct 15, 2025

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @pbearne@git.wordpress.org.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

Core Committers: Use this line as a base for the props when committing in SVN:

Props pbearne, desrosj, westonruter, wildworks, peterwilsoncc.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

pbearne and others added 3 commits October 20, 2025 12:12
Co-authored-by: Weston Ruter <westonruter@gmail.com>
Co-authored-by: Weston Ruter <westonruter@gmail.com>
Co-authored-by: Weston Ruter <westonruter@gmail.com>
Co-authored-by: Weston Ruter <westonruter@gmail.com>
Copy link
Copy Markdown
Member

@desrosj desrosj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm thinking that this would be better off as a numbered list of steps. Let's make the following changes:

  • Add an intro sentence. "You can get started using the local development environment with these steps:"
  • Where to go
  • Click create fork
  • Clone forked repo.
  • Configure upstream origin
  • How to keep your branches up to date.

After that, a include the "Alternatively" sentence.

And finally "After either if the two options above, move to the..."

pbearne and others added 2 commits November 4, 2025 10:41
Co-authored-by: Weston Ruter <westonruter@gmail.com>
Updated instructions for forking and cloning the repository with numbered steps for clarity.
@pbearne pbearne requested a review from desrosj November 4, 2025 15:53
Copy link
Copy Markdown
Member

@desrosj desrosj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few more small suggestions. I think it's good to go after those, though. I will commit tomorrow unless there are any objections.

Comment on lines +58 to +59

After either of the two options above, move to the repository folder `cd wordpress-develop` and run the following commands in a terminal:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After either of the two options above, move to the repository folder `cd wordpress-develop` and run the following commands in a terminal:

Co-authored-by: Jonathan Desrosiers <359867+desrosj@users.noreply.github.com>
@peterwilsoncc
Copy link
Copy Markdown
Contributor

This looks good to me for the purpose of clarifying to create a fork.

While editing the file, should the code spaces reference be removed as they haven't worked for a while. See https://core.trac.wordpress.org/ticket/57896

Screenshot 2025-11-11 at 10 26 39 am

Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com>
@desrosj
Copy link
Copy Markdown
Member

desrosj commented Nov 11, 2025

While editing the file, should the code spaces reference be removed as they haven't worked for a while. See https://core.trac.wordpress.org/ticket/57896

That makes sense, I think. It would be great to get that fixed, but preventing frustration for anyone attempting to use that as a means to contribute is probably best in the mean time. I'll remove that section when committing.

@desrosj desrosj added the props-bot Adding this label triggers the Props Bot workflow for a PR. label Nov 11, 2025
@github-actions github-actions bot removed the props-bot Adding this label triggers the Props Bot workflow for a PR. label Nov 11, 2025
@github-actions
Copy link
Copy Markdown

A commit was made that fixes the Trac ticket referenced in the description of this pull request.

SVN changeset: 61202
GitHub commit: 264639c

This PR will be closed, but please confirm the accuracy of this and reopen if there is more work to be done.

@github-actions github-actions bot closed this Nov 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants