-
Notifications
You must be signed in to change notification settings - Fork 55
pull requests
Amy J. Ko edited this page Jan 11, 2025
·
3 revisions
As described in the contributor guide, Wordplay uses a "fork and pull" workflow. That means for every issue you start working on, you should do the following:
- Please make sure you've forked the repository and that it's in sync with
main
. You may need to resolve conflicts if someone else edited the same things you did; talk to them to figure out which changes to keep. - Create a branch in your fork from
main
to represent the work on your issue. Format the branch name as[issue #]-[descriptive name]
so we know the branch's concerns. For example, if you were working on hypothetical issue number 27 concerning fancy colors, you might call your branch27-fancy-colors
. - Create a draft pull request (PR) for your branch, filling out the details in the template on GitHub to capture your ongoing work on the issue. Associating the issue number with the PR will help others track your progress and optionally collaborate with you.
Do you find something confusing on this page? Submit a maintenance issue, so we can improve it.