Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 2.73 KB

README.md

File metadata and controls

40 lines (28 loc) · 2.73 KB

CMS-Android

Build Status License: MIT

Get it on Google Play!

This is the Android version of the CMS BPHC app. The app uses standard Moodle endpoints from the server hosted at the CMS website.

Features

  1. Token based login
  2. View list of enrolled courses
  3. Search and register new courses
  4. Download course content once; access locally any time.
  5. Notifications for new content

Versioning

Changelogs are necessary so that the end user knows what changes were brought in each new release. This project maintains changelogs using the Keep a Changelog guidelines.

Version numbers are important in helping to differentiate releases of a product. This project follows Semantic Versioning to keep track of versions.

Android uses a unique integer for each release to the Google Version Code. To ensure proper version code semantics and proper correlation with semantic versioning, the following standard will be used:

  1. The Major version will be multipled by 1,000,000.
  2. The Minor version will be multiplied by 10,000.
  3. The Patch version will be multipled by 100.
  4. The above values will be added together to get the version code a release.
  5. Pre-releases, alpha releases etc shoud be signified by appropriate values in the least two significant digits.
  6. The changelog should state the semantic version number as well as version code (if a Playstore rollout has been done) with each release.

Contributing

You can contribute by submitting an issue, or by picking an existing one from the list and sending a PR. Ensure that the branch underlying the PR is up-to-date with latest changes. Contributors must ensure they add any significant changes to the changelog in the same PR itself.

All changes must be made on top of a new branch forked off the development branch. The master branch is only updated when a new release is made.

Commit messages should follow common guidelines, such as the ones mentioned here, whenever possible.

Mention keywords such as "Fixes" or "Closes" in commit messages, followed by the issue number, to automatically close corresponding issues. (List of keywords)

License

This app is under the MIT License.