docs: update CONTRIBUTING file

pull/262/head
Francis Lachapelle 2019-10-31 11:59:38 -04:00
parent eb4ad5e086
commit fc34befe47
1 changed files with 22 additions and 21 deletions

View File

@ -7,10 +7,10 @@ If you encounter a possible bug with SOGo, you can access our
Please make sure to respect the following guidelines when reporting a bug: Please make sure to respect the following guidelines when reporting a bug:
* verify that the bug you found is not already known or even fixed in the `master` version * verify that the bug you found is not already known or even fixed in the `master` version
* make the actual facts very clear; be precise, we need to be able to reproduce the problem * make the actual facts very clear; be precise, we need to be able to reproduce the problem
* explain your speculations, if any * explain your speculations, if any
* add a screenshot to the ticket if appropriate * add a screenshot to the ticket if appropriate
## Submitting a Pull Request ## Submitting a Pull Request
@ -43,29 +43,30 @@ format that includes a **type**, a **scope** and a **subject**:
#### Type #### Type
Must be one of the following: Must be one of the following:
* **feat**: A new feature * **feat**: A new feature
* **fix**: A bug fix * **fix**: A bug fix
* **docs**: Documentation only changes * **docs**: Documentation only changes
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing * **i18n**: Change in localizable strings
semi-colons, etc) * **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
* **refactor**: A code change that neither fixes a bug nor adds a feature semi-colons, etc)
* **perf**: A code change that improves performance * **refactor**: A code change that neither fixes a bug nor adds a feature
* **test**: Adding missing tests * **perf**: A code change that improves performance
* **chore**: Changes to the build and packaging process or auxiliary tools (sogo-tool, * **test**: Adding missing tests
sogo-ealarms-notify) and libraries such as documentation generation * **chore**: Changes to the build and packaging process or auxiliary tools (sogo-tool,
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
* mail * mail
* mail(js) * mail(js)
* calendar(css) * calendar(css)
* addressbook * addressbook
* preferences(js) * preferences(js)
* core * core
* eas * eas
#### Subject #### Subject
The subject contains a succinct description of the change: The subject contains a succinct description of the change: