Skip to content

Contributing to CommitCraft

We welcome all contributions and greatly appreciate your help in making CommitCraft better! No matter how small or large, your contribution will be valued, and credit will always be given.

Types of Contributions

Report Bugs

If you find a bug, please report it. To help us understand and fix it, include the following details:

  • Your operating system name and version.
  • Any relevant details about your local development environment.
  • Clear, step-by-step instructions to reproduce the issue.

Fix Bugs

Check the GitHub issues for bugs. Anything labeled with both "bug" and "help wanted" is open for anyone to take on. Feel free to contribute!

Implement Features

Browse the GitHub issues for feature requests. Any issue tagged with "enhancement" and "help wanted" is open to contributors who want to implement it.

Write Documentation

We always need more documentation! You can help by contributing to official documentation, docstrings in the code, or even sharing knowledge in blog posts and articles.

Submit Feedback

Have an idea for a new feature? We’d love to hear it! When proposing a feature:

  • Clearly explain how it should work.
  • Keep the scope focused and manageable to simplify the implementation.
  • Remember that this is a community-driven project, and contributions are always welcome!

How to Contribute

Ready to get started? Here's how you can set up CommitCraft for local development and make your first contribution.

  1. Fork the Repository

Go to the CommitCraft GitHub repository and click on the "Fork" button in the top-right corner. This will create a copy of the project under your GitHub account.

  1. Clone Your Fork

Clone the repository to your local machine: 

git clone https://github.com/your-username/CommitCraft.git
cd CommitCraft

  1. Install Dependencies

Install the necessary dependencies using uv (CommitCraft has migrated from Poetry): 

# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh

# Sync dependencies
uv sync

  1. Create a Branch

Create a new branch for your bug fix or feature: 

git checkout dev
git checkout -b name-of-your-bugfix-or-feature

  1. Make Changes

Implement your changes on the new branch. Make sure your code follows any existing code formatting standards, and that tests (if applicable) pass successfully.

  1. Push Changes

Once you’re satisfied with your changes, push them to your forked repository: 

git push origin name-of-your-bugfix-or-feature

  1. Open a Pull Request

Navigate to the original CommitCraft repository and click on "New Pull Request". Select the branch with your changes from your fork and submit the PR.

Pull Request Guidelines

Before submitting a pull request, make sure it meets the following criteria:

  1. Include any necessary tests for the changes.
  2. Update the documentation if the pull request adds new functionality.
  3. Ensure the changes work for all supported operating systems and Python versions.

Code of Conduct

Please note that CommitCraft is released with a Code of Conduct. By participating, you agree to follow these guidelines.

Thank you for your contributions!