pomfi/balena-allwinner
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README.md: Add contribution commit guidelines

Browse source 
Changelog-Entry: Update contribution commit guidelines
Signed-off-by: Florin Sarbu <florin@balena.io>
This commit is contained in:
Florin Sarbu 2018-11-12 11:03:47 +01:00
parent f8a22a9693
commit 2600de4847
1 changed files with 24 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -68,16 +68,37 @@ To contribute send github pull requests targeting this repository.
Please refer to: [Yocto Contribution Guidelines](https://wiki.yoctoproject.org/wiki/Contribution_Guidelines#General_Information) and try to use the commit log format as stated there. Example:
```
test.bb: I added a test
[Issue #01]
<component>: Short description
I'm going to explain here what my commit does in a way that history
would be useful.
Changelog-entry: User facing description of the issue
Signed-off-by: Joe Developer <joe.developer@example.com>
```
The header of each commit must not exceed 72 characters in length and must be in 1 line only.
The header and the subject of each commit must be separated by an empty line.
The subject of each commit must not exceed 72 characters in length but can be wrapped to several lines.
The subject and the footer of each commit must be separated by an empty line.
Every pull request must contain at least one commit annotated with the `Changelog-entry` footer. The messages contained in these footers will be used to automatically fill the changelog on every new version.
Also, every update to `meta-resin` should be separated into its own commit, if the body of that commit contains the following line `Updated meta-resin from X to Y` the generated changelog will include a button to show all the updates in `meta-resin` from the version after `X` to `Y`.
An example of a valid commit updating `meta-resin` is:
```
layers/meta-resin: Update to v2.24.0
Update meta-resin from 2.19.0 to 2.24.0
Changelog-entry: Update the meta-resin submodule from v2.19.0 to v2.24.0
```
Make sure you mention the issue addressed by a PR. See:
* https://help.github.com/articles/autolinked-references-and-urls/#issues-and-pull-requests
* https://help.github.com/articles/closing-issues-via-commit-messages/#closing-an-issue-in-a-different-repository