mirror of
https://gitee.com/dgiiot/dgiot.git
synced 2024-11-30 03:07:40 +08:00
82 lines
3.1 KiB
Markdown
82 lines
3.1 KiB
Markdown
# Contributing
|
|
|
|
You are welcome to submit any bugs, issues and feature requests on this repository.
|
|
|
|
|
|
## Commit Message Guidelines
|
|
|
|
We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that are easy to follow when looking through the **project history**.
|
|
|
|
### 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** with **type** is mandatory. The **scope** of the header is optional. This repository has no predefined scopes. A custom scope can be used for clarity if desired.
|
|
|
|
Any line of the commit message cannot be longer 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.
|
|
|
|
Example 1:
|
|
|
|
```
|
|
feat: add Fuji release compose files
|
|
```
|
|
|
|
```
|
|
fix(script): correct run script to use the right ports
|
|
|
|
Previously device services used wrong port numbers. This commit fixes the port numbers to use the latest port numbers.
|
|
|
|
Closes: #123, #245, #992
|
|
```
|
|
|
|
### 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:
|
|
|
|
- **feat**: New feature for the user, not a new feature for build script
|
|
- **fix**: Bug fix for the user, not a fix to a build script
|
|
- **docs**: Documentation only changes
|
|
- **style**: Formatting, missing semi colons, etc; no production code change
|
|
- **refactor**: Refactoring production code, eg. renaming a variable
|
|
- **chore**: Updating grunt tasks etc; no production code change
|
|
- **perf**: A code change that improves performance
|
|
- **test**: Adding missing tests, refactoring tests; no production code change
|
|
- **build**: Changes that affect the CI/CD pipeline or build system or external dependencies (example scopes: travis, jenkins, makefile)
|
|
- **ci**: Changes provided by DevOps for CI purposes.
|
|
- **revert**: Reverts a previous commit.
|
|
|
|
### Scope
|
|
|
|
There are no predefined scopes for this repository. A custom scope can be provided for clarity.
|
|
|
|
### Subject
|
|
|
|
The subject contains a succinct 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. |