diff options
| author | Martin Trigaux <mat@odoo.com> | 2018-03-16 14:45:04 +0100 |
|---|---|---|
| committer | Martin Trigaux <mat@odoo.com> | 2018-03-16 14:45:04 +0100 |
| commit | 18e7f99981c2c26ef74a16b00ac55df8cfbfe2b2 (patch) | |
| tree | e7ae2abc01fb6655b3ed2daf9efd174315eaf5e7 /doc/reference | |
| parent | 8fd8019958df3e34126c8e9022a17f07660c084b (diff) | |
[FIX] doc: correct commit guideline format
Github will automatically close the report is you use the format
Closes #number
No need to a leading #
cf https://help.github.com/articles/closing-issues-using-keywords/
Add the meaning of [I18N] tag
This commit is an example of a violation of the "one commit, one fix" principle
Diffstat (limited to 'doc/reference')
| -rw-r--r-- | doc/reference/guidelines.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/reference/guidelines.rst b/doc/reference/guidelines.rst index 041ff8bf619..a965c3a689b 100644 --- a/doc/reference/guidelines.rst +++ b/doc/reference/guidelines.rst @@ -958,8 +958,8 @@ description. Try to follow the preferred structure for your commit messages End the message with references, such as task or bug numbers, PR numbers, and OPW tickets, following the suggested format: Related to task #taskId - #Fixes #12345 (link and close issue on Github) - #Closes #7865 (link and close PR on Github) + Fixes #12345 (link and close issue on Github) + Closes #7865 (link and close PR on Github) OPW-112233 Tag and module name @@ -984,6 +984,7 @@ Tags are used to prefix your commit. They should be one of the following - **[MERGE]** for merge commits: used in forward port of bug fixes but also as main commit for feature involving several separated commits; - **[CLA]** for signing the Odoo Individual Contributor License; +- **[I18N]** for changes in translation files; After tag comes the modified module name. Use the technical name as functional name may change with time. If several modules are modified, list them or use |