jimeh/common-flow
1
0
Fork 0
mirror of https://github.com/jimeh/common-flow.git synced 2026-02-19 09:26:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Encourage a clean commit history within pull requests

Browse Source 
And also make it more obvious what pull requests are intended for.

Should address #11.
This commit is contained in:
Jim Myhrberg
2017-08-08 21:42:56 +01:00
parent 62f817a5ea
commit 7b90cfd10d
1 changed files with 11 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
common-flow.md
View File

@@ -77,12 +77,20 @@ interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
force push, and you SHOULD use the "--force-with-lease" git push option. force push, and you SHOULD use the "--force-with-lease" git push option.
4. Pull Requests 4. Pull Requests
1. To merge a change branch into its merge target, you MUST open a "pull 1. To merge a change branch into its merge target, you MUST open a "pull
request" (or equivalent) so others can review and approve your changes. request" (or equivalent).
2. A pull request MUST only be merged when the change branch is up-to-date 2. The purpose of a pull request is to allow others to review your changes
and give feedback. You can then fix any issues, complaints, and more that
might arise, and then let people review again.
3. Before creating a pull request, it is RECOMMENDED that you consider the
state of your change branch's commit history. If it is messy and
confusing, it might be a good idea to rebase your branch with "git rebase
-i" to present a cleaner and easier to follow commit history for your
reviewers.
4. A pull request MUST only be merged when the change branch is up-to-date
with its source branch, the test suite is passing, and you and others are with its source branch, the test suite is passing, and you and others are
happy with the change. This is especially important if the merge target happy with the change. This is especially important if the merge target
is the master branch. is the master branch.
3. To get feedback, help, or generally just discuss a change branch with 5. To get feedback, help, or generally just discuss a change branch with
others, the RECOMMENDED way to do so is by creating a pull request and others, the RECOMMENDED way to do so is by creating a pull request and
discuss the changes with others there. discuss the changes with others there.
5. Versioning 5. Versioning