From 13ad6ff8755e59670071212cfddd178bb8846ee9 Mon Sep 17 00:00:00 2001 From: Francis Lachapelle Date: Wed, 30 Oct 2019 11:13:40 -0400 Subject: [PATCH] Initial CONTRIBUTING file --- .github/CONTRIBUTING.md | 113 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 113 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 000000000..961b879b9 --- /dev/null +++ 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 +(): + + + +