-
Notifications
You must be signed in to change notification settings - Fork 221
Github Practices
bluong edited this page Mar 19, 2015
·
2 revisions
Placing a wiki here to document the Github practices that we have agreed upon moving forward.
Comments on general Pull Request vs Comments on Individual Commits on Pull Request
- Comments should be made at the pull request level and not at the commit level.
- Mainly due to Github's poor implementation of comments made at the commit level.
- Comments made at the commit level show up in all other pull requests dealing with the merged branch (This especially shows up when we make release pull requests. While the comments are not as important there, it's just adding more of a mess).
- Comments made at the commit level don't show any diff on the conversation main page of the pull request, requiring a click into the commit to actually see the context of the comment.
- Comments made at the commit level will not get to see any changes to the code context, meaning that comments can easily get outdated without any detection from the reviewer / author