forked from Kispi/Core
79 lines
3.1 KiB
Markdown
79 lines
3.1 KiB
Markdown
|
### Commit Message Format
|
||
|
|
|
||
|
|
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 100 characters! This allows the message to be easier to read on Gitea as well as in various git tools.
|
||
|
|
|
||
|
|
Footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-using-keywords/) if any.
|
||
|
|
|
||
|
|
Samples:
|
||
|
|
|
||
|
|
```
|
||
|
|
docs(changelog): update change log to beta.5
|
||
|
|
```
|
||
|
|
```
|
||
|
|
style(webapp): reorder imports
|
||
|
|
```
|
||
|
|
```
|
||
|
|
fix(appwrite): need to depend on latest rxjs and zone.js
|
||
|
|
|
||
|
|
The version in our package.json gets copied to the one we publish, and users need the latest of these.
|
||
|
|
```
|
||
|
|
|
||
|
|
### 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 SHA of the commit being reverted.
|
||
|
|
|
||
|
|
### Type
|
||
|
|
Must be one of the following:
|
||
|
|
|
||
|
|
* **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
|
||
|
|
* **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
|
||
|
|
* **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
|
||
|
|
* **bump**: Bump a version to X
|
||
|
|
|
||
|
|
### Scope
|
||
|
|
The following is the list of supported scopes (more to come):
|
||
|
|
|
||
|
|
* **core** used for changes to the whole project
|
||
|
|
* **webapp** used for changes made in the webapp
|
||
|
|
* **appwrite** used for changes made in the Appwrite cloud functions
|
||
|
|
* **changelog**: used for updating the release notes in CHANGELOG.md
|
||
|
|
* none/empty string: useful for `style`, `test` and `refactor` changes that are done across all packages (e.g. `style: add missing semicolons`)
|
||
|
|
|
||
|
|
|
||
|
|
### Subject
|
||
|
|
The subject contains succinct description of the change:
|
||
|
|
|
||
|
|
* use the imperative, present tense: "change" not "changed" nor "changes"
|
||
|
|
* don't capitalize 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.
|
||
|
|
|
||
|
|
### More Infos
|
||
|
|
To generate a changelog **[generate-changelog](https://github.com/lob/generate-changelog)** is used.
|