Contributors Guide¶

Thank you for your interest in contributing to Commit Tracker! We value the contributions from our community, whether they're bug fixes, new features, or documentation improvements.

How to Contribute¶

Fork the Repository: Start by forking the ct-final repository on GitHub to your personal account.
Clone Your Fork: Clone your forked repository to your local machine to start making changes.
Set Up Your Development Environment: Follow the instructions in dev.md to set up your local development environment.
Create a New Branch: For each new contribution, create a new branch from main with a descriptive name related to the contribution you're making.
Make Your Changes: Implement your changes, adhering to the coding standards and guidelines described in CONTRIBUTING.md.
Write Tests: If you're adding new functionality, write tests that cover your changes. Ensure all tests pass by running pytest.
Document Your Changes: Update or add documentation as necessary, following the project's documentation standards.
Submit a Pull Request: Push your changes to your fork on GitHub and submit a pull request to the ct-final repository. Provide a clear description of the changes and any related issue numbers.

Code of Conduct¶

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Questions or Suggestions¶

If you have questions or suggestions, feel free to open an issue on GitHub or reach out to the project maintainers directly.