Skip to content

Contributing

Vladislav Balatayev edited this page Jun 13, 2024 · 1 revision

App architecture

  • Multi-module (one feature - one module)
  • Clean (presentation, domain and data layers)
  • MVVM
  • Jetpack Compose (one activity with many composables)

Module dependency diagram

image

Naming

Branch feature|bugfix/ISSUE-ID_Ticket_name (E.g. feature/EPMEDU-953_Create_Thank_you_page)
First commit: [ISSUE ID]: Ticket name (E.g. [EPMEDU-953]: Create Thank you page )
Additional commits: Commit description (E.g. Fix detekt)
[ISSUE ID]: Ticket name (E.g. [EPMEDU-953]: Create "Thank you" page )

Work environment setup

  1. Clone the repository.
  2. Copy google-services.json into app folder.

  3. Copy MapBox keys into local.properties file.

  4. Copy Amplify configs for dev env into app/src/dev/res/raw folder.

  5. (OPTIONAL) Copy Amplify configs for QA env into app/src/qa/res/raw folder.
  6. (OPTIONAL) Copy Amplify configs for prod env into app/src/prod/res/raw folder.

Git Flow

  1. Create a new branch.
  2. Commit your changes.
  3. Create a pull request to merge the Develop branch.
  4. Apply Ready for review or In Progress label depending on the PR state.
  5. Fix comments, but resolve them only if they are minor.
  6. Apply Ready to merge label when you get 1 approval and all comments are resolved.


Clone this wiki locally