|
| 1 | +# Contribution guidelines |
| 2 | + |
| 3 | +- [Pull Requests](#pullrequest) |
| 4 | +- [Commit Message Guidelines](#commit) |
| 5 | + |
| 6 | +## <a name="pullrequest"></a> Pull Requests Guidelines |
| 7 | +Pull requests are the only means by which you can contribute to this project, please follow the following steps when submitting pull requests : |
| 8 | + |
| 9 | +1. Create your pull request. (PR name must match [commit name](#commit)) |
| 10 | +2. Fill the pull request template with all of the required elements |
| 11 | +3. CI tests kick in and report back any issues, you should fix these issues before continuing. |
| 12 | +4. The reviewer(s) uses Github review system so you will know if the reviewer requested any changes, approved the Pull Request or simply added comments. |
| 13 | +5. If any changes are requested please fix them and then once you are ready ask for a new review |
| 14 | + |
| 15 | +## <a name="commit"></a> Git Commit Guidelines |
| 16 | + |
| 17 | +### Commit Message Format |
| 18 | +A commit message is made up of a **header**, a **body** and a **footer**. The header has a special |
| 19 | +format that includes a **type**, a **scope** and a **subject**: |
| 20 | + |
| 21 | +``` |
| 22 | +<type>(<scope>): <subject> |
| 23 | +<BLANK LINE> |
| 24 | +<body> |
| 25 | +<BLANK LINE> |
| 26 | +<footer> |
| 27 | +``` |
| 28 | + |
| 29 | +* The **header** and **scope** are mandatory |
| 30 | +* Lines shouldn't exceed 100 characters |
| 31 | + |
| 32 | +#### Type |
| 33 | +Must be one of the following: |
| 34 | + |
| 35 | +* **feat**: A new feature |
| 36 | +* **fix**: A bug fix |
| 37 | +* **refactor**: Refactoring change |
| 38 | +* **docs**: Documentation only changes |
| 39 | +* **style**: Style changes (white-space, formatting, missing semi-colons, etc) |
| 40 | +* **test**: Adding missing tests |
| 41 | +* **misc**: Changes to the build process or auxiliary tools and libraries |
| 42 | + |
| 43 | +#### Scope |
| 44 | +The scope sets the scope of the commit, for example `webapi`, `akka-app`, `doa`, etc... |
| 45 | + |
| 46 | +#### Subject |
| 47 | +Brief commit description |
| 48 | + |
| 49 | +* use the imperative, present tense: "change" not "changed" nor "changes" |
| 50 | +* don't capitalize first letter |
| 51 | +* no dot (.) at the end |
| 52 | + |
| 53 | +#### Body |
| 54 | +Extended commit description and just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". |
| 55 | +The body should include the motivation for the change and contrast this with previous behaviour if any. |
| 56 | + |
| 57 | +#### Footer |
| 58 | + |
| 59 | +* any information about **Breaking Changes** |
| 60 | + |
| 61 | +**Breaking Changes** should start with the word `BREAKING CHANGES:` followed by a new line and a list of breaking changes. |
| 62 | + |
| 63 | +#### Examples |
| 64 | + |
| 65 | +``` |
| 66 | +feat(akka-app): change message serialization format |
| 67 | +
|
| 68 | +* Add new serialization format |
| 69 | +* Add serialization tests |
| 70 | +* Document the changes |
| 71 | +
|
| 72 | +BEARKING CHANGES : |
| 73 | +* Not compatible with 0.7.0 |
| 74 | +``` |
| 75 | + |
| 76 | +--- |
| 77 | + |
| 78 | +``` |
| 79 | +doc(webapi): add new routes documentation |
| 80 | +
|
| 81 | +* Document all new routes |
| 82 | +* Add exmaple snippets |
| 83 | +* Remove obselete links |
| 84 | +
|
| 85 | +``` |
| 86 | + |
| 87 | +--- |
| 88 | + |
| 89 | +``` |
| 90 | +fix(webapi): fix webapi timeout |
| 91 | +``` |
| 92 | + |
| 93 | +--- |
| 94 | + |
| 95 | +``` |
| 96 | +misc(ci): add new CI tests |
| 97 | +``` |
0 commit comments