User Tools
devel:github-contributions
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
|
devel:github-contributions [2015/08/24 19:41] miconda [Commit Message Format] |
devel:github-contributions [2016/05/12 10:40] mslehto [Basic Rules] - make pull requests against master branch |
||
|---|---|---|---|
| Line 10: | Line 10: | ||
| * github pull requests are the favourited mechanism to submit contributions (patches) | * github pull requests are the favourited mechanism to submit contributions (patches) | ||
| + | * make a pull request against master branch | ||
| + | * commit can be later backported to stable branch(es) | ||
| * make a pull request for each new feature | * make a pull request for each new feature | ||
| * e.g., if you add a feature to usrloc module and an unrelated feature to auth module, then make two pull requests | * e.g., if you add a feature to usrloc module and an unrelated feature to auth module, then make two pull requests | ||
| Line 28: | Line 30: | ||
| * when the case, make references to the item on bug tracker, using GH#XYZ - replace XYZ with issue number id | * when the case, make references to the item on bug tracker, using GH#XYZ - replace XYZ with issue number id | ||
| * e.g.,: - issue reported by John Smith, GH#123 | * e.g.,: - issue reported by John Smith, GH#123 | ||
| + | * changes to **README** file of modules must not be done directly in that file. Instead, edit the xml files located in **modules/ | ||
| + | * to regenerate the README, run **make modules-readme modules=modules/ | ||
| + | * docbook utils and xsl packages are needed for the above command to work | ||
| + | * it is ok to modify only the xml doc file, the readme can be regenerated by another developer who has the required tools installed | ||
| + | * if it is a change to README that needs to be backported, make separate commits to xml doc file and README. The changes to README files are very likely to rise merge conflicts. With separate commit, that won't be backported, only the commit to xml doc file, then README will be manually regenerated in the corresponding branch. | ||
| Line 46: | Line 53: | ||
| * module_name: | * module_name: | ||
| * lib_name: critical bug fix for abc case | * lib_name: critical bug fix for abc case | ||
| + | * kamctl: added support for management of module xyz | ||
| Examples of commit messages: | Examples of commit messages: | ||
devel/github-contributions.txt ยท Last modified: 2019/07/14 12:54 by henningw
Page Tools
