docs: update CONTRIBUTING file
parent
8b45f2c731
commit
d4f0ccd3f7
|
@ -37,10 +37,10 @@ format that includes a **type**, a **scope** and a **subject**:
|
||||||
<footer>
|
<footer>
|
||||||
```
|
```
|
||||||
|
|
||||||
> Any line of the commit message cannot be longer 100 characters!<br/>
|
> 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.
|
> This allows the message to be easier to read on GitHub as well as in various Git tools.
|
||||||
|
|
||||||
##### Type
|
#### Type
|
||||||
Must be one of the following:
|
Must be one of the following:
|
||||||
|
|
||||||
* **feat**: A new feature
|
* **feat**: A new feature
|
||||||
|
@ -54,7 +54,7 @@ Must be one of the following:
|
||||||
* **chore**: Changes to the build and packaging process or auxiliary tools (sogo-tool,
|
* **chore**: Changes to the build and packaging process or auxiliary tools (sogo-tool,
|
||||||
sogo-ealarms-notify) and libraries such as documentation generation
|
sogo-ealarms-notify) and libraries such as documentation generation
|
||||||
|
|
||||||
##### Scope
|
#### Scope
|
||||||
The scope could be anything that helps specifying the scope (or feature) that is changing.
|
The scope could be anything that helps specifying the scope (or feature) that is changing.
|
||||||
|
|
||||||
Examples
|
Examples
|
||||||
|
@ -67,25 +67,25 @@ Examples
|
||||||
* core
|
* core
|
||||||
* eas
|
* eas
|
||||||
|
|
||||||
##### Subject
|
#### Subject
|
||||||
The subject contains a succinct description of the change:
|
The subject contains a succinct description of the change:
|
||||||
|
|
||||||
* use the imperative, present tense: "change" not "changed" nor "changes"
|
* use the imperative, present tense: "change" not "changed" nor "changes"
|
||||||
* don't capitalize first letter
|
* don't capitalize first letter
|
||||||
* no dot (.) at the end
|
* no dot (.) at the end
|
||||||
|
|
||||||
##### Body
|
#### Body
|
||||||
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes"
|
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.
|
The body should include the motivation for the change and contrast this with previous behavior.
|
||||||
|
|
||||||
##### Footer
|
#### Footer
|
||||||
The footer should contain any information about **Breaking Changes** and is also the
|
The footer should contain any information about **Breaking Changes** and is also the
|
||||||
place to reference [Mantis](https://sogo.nu/bus/) issues that this commit **Fixes** or **Resolves**.
|
place to reference [Mantis](https://sogo.nu/bus/) issues that this commit **Fixes** or **Resolves**.
|
||||||
|
|
||||||
> Breaking Changes are intended to be highlighted in the CHANGELOG as changes that will require
|
> Breaking Changes are intended to be highlighted in the CHANGELOG as changes that will require
|
||||||
community users to modify their code after updating to a version that contains this commit.
|
> community users to modify their code after updating to a version that contains this commit.
|
||||||
|
|
||||||
##### Sample Commit messages:
|
#### Sample Commit messages
|
||||||
```text
|
```text
|
||||||
fix(calendar): don't raise exception when renaming with same name
|
fix(calendar): don't raise exception when renaming with same name
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue