Initial CONTRIBUTING file

2019-10-30 11:13:40 -04:00 · 2019-10-30 11:13:40 -04:00 · 13ad6ff875
parent f6ca946058
commit 13ad6ff875
1 changed files with 113 additions and 0 deletions
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@ -0,0 +1,113 @@
+# Contributing to SOGo
+
+## Reporting Bugs and Suggesting Enhancements
+
+If you encounter a possible bug with SOGo, you can access our
+[bug tracking system](https://sogo.nu/bugs/).
+
+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
+* make the actual facts very clear; be precise, we need to be able to reproduce the problem
+* explain your speculations, if any
+* add a screenshot to the ticket if appropriate
+
+## Submitting a Pull Request
+
+Begin by reading [SOGo Developer's Guide](../Documentation/SOGoDevelopersGuide.asciidoc).
+
+### Git Commit 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**.
+
+It is important to note that we use the git commit messages to **generate** the
+[CHANGELOG](../CHANGELOG.md) document. Improperly formatted commit messages may result in your
+change not appearing in the CHANGELOG of the next release.
+
+### 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**:
+
+```html
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+> Any line of the commit message cannot be longer 100 characters!<br/>
+  This allows the message to be easier to read on GitHub as well as in various Git tools.
+
+##### Type
+Must be one of the following:
+
+* **feat**: A new feature
+* **fix**: A bug fix
+* **docs**: Documentation only changes
+* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
+  semi-colons, etc)
+* **refactor**: A code change that neither fixes a bug nor adds a feature
+* **perf**: A code change that improves performance
+* **test**: Adding missing tests
+* **chore**: Changes to the build and packaging process or auxiliary tools (sogo-tool,
+  sogo-ealarms-notify) and libraries such as documentation generation
+
+##### Scope
+The scope could be anything that helps specifying the scope (or feature) that is changing.
+
+Examples
+
+* mail
+* mail(js)
+* calendar(css)
+* addressbook
+* preferences(js)
+* core
+* eas
+
+##### Subject
+The subject contains a 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 [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
+  community users to modify their code after updating to a version that contains this commit.
+
+##### Sample Commit messages:
+```text
+fix(calendar): don't raise exception when renaming with same name
+
+this would break Apple Calendar.app when creating a new calendar
+
+Fixes #4813
+```
+```text
+feat(calendar(js)): optionally expand LDAP groups in attendees editor
+
+* add `/members` action for LDIF groups
+* add button to expand invited LDAP groups
+
+Fixes #2506
+```
+```text
+fix(core): set default Sieve port to 4190
+
+BREAKING CHANGE: the default port for the SOGoSieveServer configuration default is now 4190 (was
+2000).
+
+You need to explicitly set the port if you use a different port.
+
+Closes #4826
+```