diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5f02d89e96..f8b8b83023 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,11 +13,17 @@ contributors, the general procedure for contributing has been established: 3. if you would then like to contribute code: a. if a the issue is a proposal, ensure that the proposal has been accepted, b. ensure that nobody else has already begun working on this issue, if they have - make sure to contact them to collabourate, - c. if nobody has been assigned the issue, and you would like to work on it - make a comment on the issue that you are beginning to work on it, + make sure to contact them to collaborate, + c. if nobody has been assigned the issue and you would like to work on it + make a comment on the issue to inform the community of your intentions + to begin work, d. follow standard github best practices: fork the repo, branch from the - tip of develop, make some commits, and submit a pull request to develop. + tip of `develop`, make some commits, and submit a PR to `develop`, + e. include `WIP:` in the PR-title to and submit your PR early, even if it's + incomplete, this indicates to the community you're working on something and + allows them to provide comments early in the development process. When the code + is complete it can be marked as ready-for-review by replacing `WIP:` with + `R4R:` in the PR-title. Note that for very small or blatantly obvious problems (such as typos) it is not required to an open issue to submit a PR, but be aware that for more complex