[WIP] Added documentation for handing pull requests #20
Conversation
…that it also covers guidelines for writing pull requests
Pull_Requests.md
Outdated
| \ | ||
| The following are some general rules of how a reviewer should review a pull request:\ | ||
| - If the PR is labelled as "WIP" then it should not be approved. | ||
| - Thoroughly go all changes made and if neccesary leave feedback. |
There was a problem hiding this comment.
@rrasmuss4200 Oops, I didn't get an email notification for any of your comments so I did not see them until now. I'll give it another read over and fix the typos. Also I'll add a section for drafting PR's. Thanks for the feedback!
There was a problem hiding this comment.
@rrasmuss4200 I fixed the typo and added a code styling section for rust (Using clippy and rust analyzer).
On a different note, in the contributing document there is still a section about using copyright information which I think may be out of date. I remember Devin mentioning that we no longer need to put the copyright info in each code file and now we just have a single license doc in the repo. Let me know if I should remove that section in this PR.
In regards to #18
In this branch I added a markdown file that documents how to handle pull requests. It covers the following topics:
These guidelines and rules are based off of a couple of github articles:
As the rules of reviewing pull requests affects all reviewers I am open to all feedback. Please let me know what you think of the definitions for approving, requesting changes, and commenting. Also let me know if the job of actually merging the branch should be the job of either the reviewer or the creator of the pull request, In this document I just said it could be either but it would be nice to have a concrete definition of roles.