Committing to the Repository

Thank you for considering contributing to Mitup! We appreciate all contributions, from bug reports, documentation improvements, and code changes. Please review our Code of Conduct before participating.

While this page details the process for code submissions, you can find other ways to help in the Being a Supporter guide.

To contribute changes to this project, please follow these steps:

1. Create an Issue

Before starting development, open an issue first to track the proposed change. This ensures transparency and allows for discussion. Use the appropriate template for the type of issue:

• Bug Report: Report unexpected behavior or errors. Create Bug Report
• Feature Proposal: Suggest a new feature or enhancement. Propose Feature
• Documentation Improvement: Suggest changes to the documentation. Improve Documentation
• Task: For general tasks not covered by other templates. Create Task
• Translation: Contribute or update translations. Add Translation
• New Language Request: Propose adding support for a new language. Request Language

Discuss the issue with maintainers if necessary before proceeding.

2. Fork and Clone the Repository

Fork the repository to your own namespace and clone it locally to begin development.

3. Develop Your Changes

Create a new branch for your changes. Name the branch starting with the issue number followed by a descriptive name (e.g., 123-fix-validation-logic). This helps automatically link the branch and subsequent merge request to the issue in GitLab.

Before committing your changes, ensure you have completed the Setup steps and that pre-commit hooks are installed and running correctly. This step performs local validation checks (like linting and formatting) automatically when you commit, simplifying the review process. We also recommend running the full set of Local Validation checks before opening a Merge Request.

Implement the required changes in your local repository. Commit your work with clear, concise messages that follow the Conventional Commits standard. This repository uses a custom commit message formatter that automatically transforms your commits into an emoji-based format. See the Commit Message Format guide for detailed information on how to write commits and what transformations are applied. The formatter is enforced by a pre-commit hook defined in the .pre-commit-config.yaml file, and the specific types supported are configured in the commits_check_config.yaml file.

4. Merge Request Process

Once development is complete, push your changes to your fork and then open a Merge Request (MR) against the project's main branch.

• Description: Provide a clear description of the changes, linking to the related issue.
• Pipeline Validation: The CI/CD pipeline automatically runs tests and linters against your MR. Ensure that all pipeline jobs pass. Address any reported failures.
• Sourcery AI Review: We use Sourcery AI for automated code review. Address any relevant suggestions from Sourcery's analysis.
• Human Review: After automated checks pass, a project maintainer will review the MR. Address any feedback received during the review.
• Approval and Merge: Once approved, the maintainer will merge your MR into the main branch.

Thank you for your contribution.

---

By contributing, you agree that your contributions will be licensed under the MIT License.