LupusNobilis
/
sogo
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: update CONTRIBUTING file

pull/262/head
Francis Lachapelle 2019-10-30 13:54:06 -04:00
parent 8b45f2c731
commit d4f0ccd3f7
1 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
.github/CONTRIBUTING.md vendored
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
@ -37,55 +37,55 @@ 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
* **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 * **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
semi-colons, etc) semi-colons, etc)
* **refactor**: A code change that neither fixes a bug nor adds a feature * **refactor**: A code change that neither fixes a bug nor adds a feature
* **perf**: A code change that improves performance * **perf**: A code change that improves performance
* **test**: Adding missing tests * **test**: Adding missing tests
* **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
* 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:
* 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