forked from xurror/web-app
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add COMMIT_MESSAGE.md (openMF#22)
Add guidelines to be followed for a meaningful commit message.
Fixes: #18- Loading branch information
1 parent
27696fa
commit 356acf0
Showing
1 changed file
with
87 additions
and
0 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| # Commit Message Conventions | ||
|
|
||
| Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**: | ||
|
|
||
| ``` | ||
| <type>(<scope>): <subject> | ||
| <BLANK LINE> | ||
| <body> | ||
| <BLANK LINE> | ||
| <footer> | ||
| ``` | ||
|
|
||
| The **header** is mandatory and the **scope** of the header is optional. | ||
|
|
||
| Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools. | ||
|
|
||
| The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any. | ||
|
|
||
| ### Revert | ||
| If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the commit id of the commit being reverted. | ||
|
|
||
| ### Type | ||
| Must be one of the following: | ||
|
|
||
| * **build**: Changes that affect the build system or external dependencies (example scopes: npm, webpack etc) | ||
| * **chore**: Other changes that don't modify src or test files | ||
| * **ci**: Changes to CI configuration files and scripts (example scopes: Travis etc) | ||
| * **docs**: Documentation only changes | ||
| * **feat**: A new feature | ||
| * **fix**: A bug fix | ||
| * **perf**: A code change that improves performance | ||
| * **refactor**: A code change that neither fixes a bug nor adds a feature | ||
| * **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons etc) | ||
| * **test**: Adding missing tests or correcting existing tests | ||
|
|
||
| ### Scope | ||
| The scope could be anything specifying place of the commit change or empty. (example: main.scss, login etc) | ||
|
|
||
| ### Subject | ||
| The subject contains a brief and clear description of the change: | ||
|
|
||
| * use the imperative, present tense: "change" not "changed" nor "changes" | ||
| * don't capitalize the first letter | ||
| * no dot (.) at the end | ||
|
|
||
| ### Body | ||
| Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior. | ||
|
|
||
| ### Footer | ||
| The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**. | ||
|
|
||
| **Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this. | ||
|
|
||
|
|
||
| ## Example Commit Message | ||
| ``` | ||
| feat: Summarize changes in around 50 characters or less | ||
| More detailed explanatory text, if necessary. Wrap it to about 72 | ||
| characters or so. In some contexts, the first line is treated as the | ||
| subject of the commit and the rest of the text as the body. The | ||
| blank line separating the summary from the body is critical (unless | ||
| you omit the body entirely); various tools like `log`, `shortlog` | ||
| and `rebase` can get confused if you run the two together. | ||
| Explain the problem that this commit is solving. Focus on why you | ||
| are making this change as opposed to how (the code explains that). | ||
| Are there side effects or other unintuitive consequenses of this | ||
| change? Here's the place to explain them. | ||
| Further paragraphs come after blank lines. | ||
| - Bullet points are okay, too | ||
| - Typically a hyphen or asterisk is used for the bullet, preceded | ||
| by a single space, with blank lines in between, but conventions | ||
| vary here | ||
| If you use an issue tracker, put references to them at the bottom, | ||
| like this: | ||
| Fixes: #123 | ||
| See also: #456, #789 | ||
| This would automatically notify GitHub to close the issue once the PR | ||
| is merged. Do not do this if the PR solves only a part of the issue. | ||
| ``` |