Skip to content

Latest commit

 

History

History
79 lines (49 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

79 lines (49 loc) · 3.01 KB

Contributing to GitMuse

Thank you for your interest in contributing to GitMuse! We welcome contributions from everyone. Please take a moment to review this guide to make the contribution process easy and effective for everyone involved.

How Can I Contribute?

Reporting Bugs

If you find a bug, please report it by opening an issue on the GitHub repository. Include as much detail as possible to help us diagnose and fix the issue quickly. Details might include:

  • Your operating system and version
  • Python version
  • Steps to reproduce the bug
  • Expected and actual behavior
  • Any relevant logs or error messages

Suggesting Enhancements

We are always open to new ideas! If you have a feature request or enhancement suggestion, please open an issue and describe:

  • The problem your suggestion solves
  • A detailed description of the suggested enhancement
  • Any other solutions or workarounds you’ve considered

Submitting Pull Requests

Before starting any work, please check the existing issues and pull requests to see if someone else is already working on something similar. If not, you are welcome to start your work by following these steps:

  1. Fork the Repository: Click the "Fork" button on the GitHub page of the repository and clone your fork:

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

  2. Create a Branch: Create a new branch for your work:

    git checkout -b feature-or-bugfix-name

  3. Make Changes: Implement your changes and commit them with clear and concise messages:

    git add .
git commit -m "A clear and descriptive commit message"

  4. Run Tests: Ensure all tests pass before submitting your pull request. If applicable, add new tests for your changes.

  5. Push Changes: Push your changes to your fork:

    git push origin feature-or-bugfix-name

  6. Submit a Pull Request: Open a pull request against the main repository's main branch. Provide a detailed description of your changes and any related issue numbers.

Code Style

Please follow the coding style used in the project. This includes:

  • Consistent use of indentation and whitespace
  • Meaningful variable and function names
  • Commenting your code where necessary

We use tools like ruff and mypy to maintain code quality and style. Ensure your code passes these checks before submitting your pull request.

Documentation

If your contribution changes any part of the public API or is significant in nature, please update the documentation accordingly. This includes updating the README.md file and any other relevant documentation files.

Community Guidelines

Be respectful and considerate of others when contributing to this project. We are all here to improve the project, and everyone deserves to be treated with courtesy and kindness.

Thank You

Your contributions are what make this project great. Thank you for taking the time to contribute to GitMuse!