Skip to content

Commit eca97bd

Browse files
authored
Clarify WIP PR instructions (#237)
A new contributor noted some confusion from the text around WIP PRs, so this attempts to clean up the text around that part of our contributor guide. It also switches from recommending “WIP” in the title to using GitHub’s “draft” feature (didn’t exist when this guide was written!) and suggests noting issue numbers in commit messages (another thing I’ve found myself pointing out a lot).
1 parent 876a9c4 commit eca97bd

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ Our process for accepting changes operates by [Pull Request (PR)](https://help.g
3030

3131
$ git checkout -b <branch-name>
3232

33-
1. **Create or modify the files** with your changes. If you want to show other people work that isn't ready to merge in, commit your changes then create a pull request (PR) with _WIP_ or _Work In Progress_ in the title.
33+
1. **Create or modify the files** with your changes and commit them in Git. If you are fixing a known issue, include [“fixes #123” (where “123” is the issue number) in one of your commit messages](https://help.github.com/en/github/managing-your-work-on-github/closing-issues-using-keywords) to help automatically link everything together.
3434

35-
https://github.com/edgi-govdata-archiving/<repository-name>/pull/new/master
35+
1. Once your changes are ready for review, push your commits to GitHub and **[create a pull request (PR)](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).** If you aren’t ready for final review and just need some preliminary feedback, create the PR as a *draft:*
3636

37-
1. Once your changes are ready for final review, commit your changes then modify or **create your pull request (PR)**, assign as a reviewer or ping (using "`@<username>`") a Lieutenant (someone able to merge in PRs) active on the project (all Lieutenants can be pinged via `@edgi-govdata-archiving/lieutenants`)
37+
![Screenshot of PR button with “draft” option](https://help.github.com/assets/images/help/pull_requests/pullrequest-send.png)
3838

3939
1. Allow others sufficient **time for review and comments** before merging. We make use of GitHub's review feature to comment in-line on PRs when possible. There may be some fixes or adjustments you'll have to make based on feedback.
4040

0 commit comments

Comments
 (0)