/zc_app_android

Primary LanguageKotlin

Zuri Chat


License API

Overview

This is The Android repository for Zuri Chat project.

Contributing

  • Fork the project.
  • Clone your own forked repository, run git clone "https://github.com/[your_github_username]/zc_app_android.git"

Add remote upstream using the command git remote add upstream "https://github.com/zurichat/zc_app_android.git"

  • run: git fetch upstream - You must fetch from develop before or after checkout
  • run: git merge upstream/develop - Merge updates from upstream
  • git checkout -b feat/user-login - You are in the feat/user-login branch now
    To push to github;
  • git add .
  • git commit -m "feat: implemented user login"
  • git push origin feat/user-login - note how it ends with a branch.

Commit Message Format: chore, feature, bug

For a feature: git commit -m "feat: implemented user log-in"
For a bug: git commit -m "bug: fixed inconsistency in log in screen"
For a chore: git commit -m "chore: updated read me to include API endpoints"

  • Create your PR to the develop branch of this repository.

When making a PR, your PR is expected to have the following comments:

  • What is the task completed ?
  • What the PR actually does ?
  • How can this PR be manually tested ?
  • Any background contexts ? (maybe something a tester might not notice and be useful for testing)
  • Screenshots (of your implementation - a web page, a mobile app screen or an API payload

For Fragments, use the already created delegate function viewBinding() to use viewBinding. Read more here