ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-05-30 23:29:30 +03:00
Code Issues Projects Releases Wiki Activity

Contributing: "Git commit conventions" after "General workflow"

Browse Source 
Also linkified to the GitHub docs about 'Closes #XXX' and the like.
This commit is contained in:
Athanasius 2021-06-07 12:26:01 +01:00
parent 81652a54c2
commit 93dbaee5ae
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Contributing.md
View File

@ -45,6 +45,20 @@ and another for the Pull Request, merging or cherry-picking commits as needed.
---
## Git commit conventions
* Please use the standard Git convention of a short title in the first line and fuller body text in subsequent lines.
* Please reference issue numbers using the "hashtag" format #123 in your commit message wherever possible.
This lets GitHub create two-way hyperlinks between the issue report and the commit.
[Certain text](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
in a PR that fixes an issue can auto-close the issue when the PR is merged.
Note the caveats about the extended forms being necessary in some situations.
* If in doubt, lean towards many small commits. This makes git bisect much more useful.
* Please try at all costs to avoid a "mixed-up" commit, i.e. one that addresses more than one issue at once.
One thing at a time is best.
---
## Git branch structure and tag conventions
Somewhat based on git-flow, but our particular take on it:
@ -409,18 +423,6 @@ Additionally, if your hack is over around 5 lines, please include a `# HACK END`
---
## Git commit conventions
* Please use the standard Git convention of a short title in the first line and fuller body text in subsequent lines.
* Please reference issue numbers using the "hashtag" format #123 in your commit message wherever possible.
This lets GitHub create two-way hyperlinks between the issue report and the commit.
Certain text in a PR that fixes an issue can auto-close the issue when the PR is merged.
* If in doubt, lean towards many small commits. This makes git bisect much more useful.
* Please try at all costs to avoid a "mixed-up" commit, i.e. one that addresses more than one issue at once.
One thing at a time is best.
---
## Build process
See [Releasing.md](docs/Releasing.md) for the environment and procedure necessary for building the application into