Update README.md
This commit is contained in:
12
README.md
12
README.md
@@ -1,14 +1,18 @@
|
||||
~ What is RiskAhead?
|
||||
What is RiskAhead-Android?
|
||||
----------------------------
|
||||
|
||||
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.
|
||||
|
||||
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>
|
||||
where is one of the following:
|
||||
@@ -21,9 +25,11 @@ 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. For example:
|
||||
|
||||
feat: A new feature to make something better
|
||||
|
||||
now it will be available to call api.function() with additional parameters like api.function(Integer)
|
||||
it will be included in release notes as:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user