dennisthiessen/RiskAhead-API
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Dennis Thiessen
2017-04-05 15:46:34 +02:00
parent 39a749a5d0
commit 70fad05802
1 changed files with 17 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@@ -14,26 +14,26 @@ This projects is about the native RiskAhead Android App
Commit messages are used to generate the release notes for each release.
To do this, we loosely follow the AngularJS commit conventions: for commit messages to appear in the release notes, the title line needs to respect the following format:
<type>: <message>
where is one of the following:
```
<type>: <message>
```
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 or adds a feature
perf: A code change that improves performance
test: Adding missing tests
chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
where type is one of the following:
Also commits can consists of several lines - to include some additional information in relase notes. For example:
**feat:** A new feature
feat: A new feature to make something better
**fix:** A bug fix
now it will be available to call api.function() with additional parameters like api.function(Integer)
it will be included in release notes as:
**docs:** Documentation only changes
feat: A new feature to make something better
**style:** Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
now it will be available to call api.function() with additional parameters like api.function(Integer)
Please take a look at release notes to find some more examples of mutiline commits.
**refactor:** A code change that neither fixes a bug or adds a feature
**perf:** A code change that improves performance
**test:** Adding missing tests
**chore:** Changes to the build process or auxiliary tools and libraries such as documentation generation
Also commits can consists of several lines - to include some additional information in relase notes.