Contribution Guide

Thank you for contributing to this project! To maintain a clean git history and facilitate the review process, please follow these standardization rules.

1. Commit Message Format

We use a simplified Conventional Commits format:

Format: type(scope): description

Examples:

• feat(auth): add login validation
• fix(home): resolve crash on scroll
• chore(deps): update koin version

Available Types:

• feat: New feature.
• fix: Bug fix.
• docs: Documentation changes.
• style: Formatting changes, missing semi-colons, etc. (not actual code changes).
• refactor: Code changes that neither fix a bug nor add a feature.
• test: Adding or fixing tests.
• chore: Changes to the build process or external libraries.

---

2. Pull Request (PR) Standard

Pull Request Title

The PR title must include the type, scope, short description, and ticket ID (AND-ID).

Format: type(scope): description #AND-ID

Example: feat(auth): create auth #AND-1

Pull Request Body Template

Use the following template when creating a Pull Request description:

## Scope
YouTrack: #AND-ID

## Changes
- What changed?
- Why is this change necessary?

## How to Test
- List the steps to verify your changes.
- Example: Open login screen, enter incorrect email, click submit.

---

3. Additional Rules

1. Ticket ID: You MUST link the ticket ID (e.g., #AND-123) in the PR Title.
2. Atomic Commits: Try to keep each commit focused on a single logical functionality.
3. Self Review: Ensure you have run the application and performed a self-review of your code before creating a PR.
4. No Conflicts: Ensure your branch is updated with the latest main branch and has no conflicts.