docs: add commits convention description in CONTRIBUTING.rst #83
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
IlyaFaer
requested changes
Nov 28, 2019
CONTRIBUTING.rst
Outdated
Comment on lines
161
to
181
| The commit message should be structured as follows:: | ||
|
|
||
| <type>[optional scope]: <description> | ||
|
|
||
| [optional body] | ||
|
|
||
| [optional footer(s)] | ||
|
|
||
| The commit contains the following structural elements: | ||
|
|
||
| - **fix**: a commit of the type `fix` patches a bug in the codebase. | ||
| - **feat**: a commit of the type `feat` introduces a new feature to the codebase. | ||
| - **BREAKING CHANGE**: a commit that has a footer `BREAKING CHANGE:`, or | ||
| appends a `!` after the type/scope, introduces a breaking API change. A | ||
| BREAKING CHANGE can be part of commits of any type. | ||
| - types other than fix: and feat: are allowed, for example recommends `build:`, | ||
| `chore:`, `ci:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`, `docs:` | ||
| and others. | ||
| - footers other than BREAKING CHANGE: <description> may be provided and follow | ||
| a convention similar to `git trailer format`_. | ||
|
|
There was a problem hiding this comment.
Let's not include standard description, as this will cause us to manually synchronize it's text if standard will be changed. Just title, short remark and links to the original standard text.
IlyaFaer
reviewed
Nov 28, 2019
CONTRIBUTING.rst
Outdated
| @@ -151,6 +151,37 @@ Exceptions to PEP8: | |||
| "Function-Under-Test"), which is PEP8-incompliant, but more readable. | |||
| Some also use a local variable, ``MUT`` (short for "Module-Under-Test"). | |||
|
|
|||
| ***************** | |||
| Commit Convention | |||
There was a problem hiding this comment.
Commit Message Convention
IlyaFaer
approved these changes
Nov 28, 2019
mf2199
approved these changes
Nov 28, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
IPR 9897
This PR adds commit convention description in CONTRIBUTING.rst.
PR checklist: