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-04 17:17:39 +02:00
parent 826a4c95d1
commit 39a749a5d0
1 changed files with 16 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -1,29 +1,35 @@
~ What is RiskAhead? What is RiskAhead-Android?
----------------------------
RiskAhead is your global tool to inform about violence in your vicinity and report crime anonymously. RiskAhead is your global tool to inform about violence in your vicinity and report crime anonymously.
Avoid crimes, violence, natural disasters and catastrophes via warnings about attacks, vandalism, drug abuse, car robbery, thefts, shootings, sexual harassment, rape, murder, terror bombing, terrorism and further more. Avoid crimes, violence, natural disasters and catastrophes via warnings about attacks, vandalism, drug abuse, car robbery, thefts, shootings, sexual harassment, rape, murder, terror bombing, terrorism and further more.
This projects is about the native RiskAhead Android App
~ Commit message conventions Commit message conventions
-----------------------------
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: 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> <type>: <message>
where is one of the following: where is 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 semi-colons, etc) 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 refactor: A code change that neither fixes a bug or 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 process or auxiliary tools and libraries such as documentation generation 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. For example: Also commits can consists of several lines - to include some additional information in relase notes. For example:
feat: A new feature to make something better feat: A new feature to make something better
now it will be available to call api.function() with additional parameters like api.function(Integer) now it will be available to call api.function() with additional parameters like api.function(Integer)
it will be included in release notes as: it will be included in release notes as: