Add docs for PR (feedback) (dotnet/corefx#9827)
authorHugh Bellamy <hughbellars@gmail.com>
Sun, 3 Jul 2016 23:05:25 +0000 (00:05 +0100)
committerStephen Toub <stoub@microsoft.com>
Sun, 3 Jul 2016 23:05:25 +0000 (19:05 -0400)
* Add docs for PR (feedback)

Fixes dotnet/corefx#1063

* Change sentence style

* Fix some wording

Commit migrated from https://github.com/dotnet/corefx/commit/a2f7b55ef1f4001b136d81f4718a8ca5cfffdf03

docs/libraries/project-docs/contributing.md

index 8e337ac..e379464 100644 (file)
@@ -16,3 +16,15 @@ API Changes
 -----------
 
 * **DO NOT** submit to the *master* branch API additions to any type that has shipped in the full .NET framework. Instead, use the *future* branch. See [Branching Guide](branching-guide.md). Further, do not submit such PRs until the APIs have been approved via the [API Review Process](api-review-process.md).
+
+Pull Requests
+-------------
+
+* **DO** submit all code changes via pull requests (PRs) rather than through a direct commit. PRs will be merged after a peer review by one or more Microsoft employees.
+* **DO** give PRs have descriptive names (i.e. not "Fix #1234")
+* **DO** refer to any issues, and include [keywords](https://help.github.com/articles/closing-issues-via-commit-messages/) that automatically close issues when the PR is merged.
+* **DO** tag any users to review or look at the change.
+* **DO** ensure each commit produces a successful build (and preferably passes relevant tests).
+* **DO** include PR feedback should be done in seperate commits, and only rebase or squash them when necessary.
+* **DO NOT** fix merge conflicts using a merge commit. Prefer `git rebase dotnet/master`.
+* **DO NOT** squash commits before they are merged. If necessary, squashing should be handled by the merger using the ["Confirm squash and merge"](https://github.com/blog/2141-squash-your-commits) feature.