Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

59 lines (37 loc) · 2.43 KB

Contributing to Colorthon

Thank you for considering contributing to Colorthon! We welcome your ideas, bug reports, feature requests, and pull requests to help improve the package and make it even better.

How to Contribute

To contribute to Colorthon, please follow these steps:

  1. Fork the Colorthon repository to your GitHub account.
  2. Clone the forked repository to your local machine.
git clone https://github.com/your-username/colorthon.git
  1. Create a new branch for your contribution. It is recommended to use a descriptive branch name that explains the purpose of your changes.
git checkout -b feature/my-contribution
  1. Make your changes or additions to the codebase.
  2. Test your changes and ensure that they work as expected. You can also consider adding new tests if applicable.
  3. Commit your changes with a clear and descriptive commit message.
git commit -m "Add feature X" or "Fix bug Y"
  1. Push your changes to your forked repository.
git push origin feature/my-contribution
  1. Open a new pull request on the original Colorthon repository. Provide a detailed description of the changes you made and why they are beneficial.

Code Style and Guidelines

To maintain a consistent and high-quality codebase, we adhere to the following guidelines:

  • Follow the PEP 8 style guide for Python code.
  • Write clear and concise code with appropriate variable and function names.
  • Add comments to explain complex logic or any non-obvious code.
  • Ensure proper indentation and formatting.

Bug Reports and Feature Requests

If you encounter any bugs while using Colorthon or have any ideas for new features, please open an issue on the GitHub repository. Provide as much detail as possible about the problem or feature request, including steps to reproduce or a clear description of the desired functionality.

Code of Conduct

Colorthon adheres to a Code of Conduct to foster a welcoming and inclusive community. We expect all contributors to follow this code when participating in the project.

License

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

We appreciate your interest in improving Colorthon, and we look forward to your contributions! Thank you for helping us make this package better for everyone.