Guidelines

Project initiation guidelines

• Android SDK as follow here. A the time of written (Feb 2021), reccomend API level 30.
• For compatibility between Android Studio and Intellij, setting as follow here.
• .gitignore should include at least:
  
  
  • .idea/
  • gradle/wrapper/
  • gradle.properties
  • settings.gradle
  
  
• Java SDK either 14.0 or higher, or 8.0 for legacy support.

Contribution guidelines

1. Pull the latest version-branch (i.e. v2.1)
2. Create a new branch to implement a feature. Naming branch according to the feature is recommended.
3. Create a new pull request to the version-branch (not master) when finished.
4. Do not make direct change (merge, edit) to the version-branch or the master branch.

Version releasing guidelines

1. Test the project thoroughly.
2. Commit a version release checkpoint, marked as RELEASE Vx.x
3. Merge to master.
4. Do not delete the branch.
5. Branch from master for next version.