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

Update links to be compatible with GitHub Pages

Browse Source
This commit is contained in:
Jim Myhrberg
2017-07-03 15:39:54 +01:00
parent 727f207b26
commit 3f31908876
1 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
common-flow.md
View File

@@ -83,13 +83,15 @@ interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
discuss the changes with others there. discuss the changes with others there.
3. Git Best Practices 3. Git Best Practices
1. All commit messages SHOULD follow the Commit Guidelines and format from 1. All commit messages SHOULD follow the Commit Guidelines and format from
the official git documentation: the official git
https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project documentation:
<https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project>
2. You SHOULD always use "--force-with-lease" when doing a force push. The 2. You SHOULD always use "--force-with-lease" when doing a force push. The
plain "--force" option is dangerous and destructive. More information: plain "--force" option is dangerous and destructive. More
https://developer.atlassian.com/blog/2015/04/force-with-lease/ information:
3. You SHOULD understand and be comfortable with rebasing: <https://developer.atlassian.com/blog/2015/04/force-with-lease/>
https://git-scm.com/book/en/v2/Git-Branching-Rebasing 3. You SHOULD understand and be comfortable with
rebasing: <https://git-scm.com/book/en/v2/Git-Branching-Rebasing>
4. It is RECOMMENDED that you always do "git pull --rebase" instead of "git 4. It is RECOMMENDED that you always do "git pull --rebase" instead of "git
pull" to avoid unnecessary merge commits. You can make this the default pull" to avoid unnecessary merge commits. You can make this the default
behavior of "git pull" with "git config --global pull.rebase true". behavior of "git pull" with "git config --global pull.rebase true".
@@ -104,9 +106,9 @@ interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
2. If you are using a "VERSION" file in the root of the project, this MUST 2. If you are using a "VERSION" file in the root of the project, this MUST
only contain the exact version string. only contain the exact version string.
3. The version string SHOULD follow the Semantic Versioning 3. The version string SHOULD follow the Semantic Versioning
(http://semver.org/) format. Use of Semantic Versioning is OPTIONAL, but (<http://semver.org/>) format. Use of Semantic Versioning is OPTIONAL,
the version string MUST NOT have a "v" prefix. For example "v2.11.4" is but the version string MUST NOT have a "v" prefix. For example "v2.11.4"
bad, and "2.11.4" is good. is bad, and "2.11.4" is good.
5. Releases 5. Releases
1. To create a new release, you MUST create a "version bump" commit directly 1. To create a new release, you MUST create a "version bump" commit directly
on the master branch which changes the hard-coded version value of the on the master branch which changes the hard-coded version value of the