Update README.md
This commit is contained in:
committed by
Dennis Thiessen
parent
39a749a5d0
commit
7d698e5181
2
.idea/modules.xml
generated
2
.idea/modules.xml
generated
@@ -2,8 +2,8 @@
|
||||
<project version="4">
|
||||
<component name="ProjectModuleManager">
|
||||
<modules>
|
||||
<module fileurl="file://$PROJECT_DIR$/RiskAhead.iml" filepath="$PROJECT_DIR$/RiskAhead.iml" />
|
||||
<module fileurl="file://$PROJECT_DIR$/app/app.iml" filepath="$PROJECT_DIR$/app/app.iml" />
|
||||
<module fileurl="file://$PROJECT_DIR$/riskAhead.iml" filepath="$PROJECT_DIR$/riskAhead.iml" />
|
||||
</modules>
|
||||
</component>
|
||||
</project>
|
||||
6
.idea/vcs.xml
generated
6
.idea/vcs.xml
generated
@@ -1,6 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="VcsDirectoryMappings">
|
||||
<mapping directory="$PROJECT_DIR$" vcs="Git" />
|
||||
</component>
|
||||
</project>
|
||||
34
README.md
34
README.md
@@ -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.
|
||||
|
||||
19
RiskAhead-Android.iml
Normal file
19
RiskAhead-Android.iml
Normal file
@@ -0,0 +1,19 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<module external.linked.project.id="RiskAhead-Android" external.linked.project.path="$MODULE_DIR$" external.root.project.path="$MODULE_DIR$" external.system.id="GRADLE" type="JAVA_MODULE" version="4">
|
||||
<component name="FacetManager">
|
||||
<facet type="java-gradle" name="Java-Gradle">
|
||||
<configuration>
|
||||
<option name="BUILD_FOLDER_PATH" value="$MODULE_DIR$/build" />
|
||||
<option name="BUILDABLE" value="false" />
|
||||
</configuration>
|
||||
</facet>
|
||||
</component>
|
||||
<component name="NewModuleRootManager" LANGUAGE_LEVEL="JDK_1_7" inherit-compiler-output="true">
|
||||
<exclude-output />
|
||||
<content url="file://$MODULE_DIR$">
|
||||
<excludeFolder url="file://$MODULE_DIR$/.gradle" />
|
||||
</content>
|
||||
<orderEntry type="jdk" jdkName="JDK" jdkType="JavaSDK" />
|
||||
<orderEntry type="sourceFolder" forTests="false" />
|
||||
</component>
|
||||
</module>
|
||||
@@ -9,7 +9,6 @@
|
||||
<facet type="android" name="Android">
|
||||
<configuration>
|
||||
<option name="SELECTED_BUILD_VARIANT" value="debug" />
|
||||
<option name="SELECTED_TEST_ARTIFACT" value="_android_test_" />
|
||||
<option name="ASSEMBLE_TASK_NAME" value="assembleDebug" />
|
||||
<option name="COMPILE_JAVA_TASK_NAME" value="compileDebugSources" />
|
||||
<afterSyncTasks>
|
||||
|
||||
Reference in New Issue
Block a user