Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

56 lines (38 loc) · 2.15 KB
Raw

Contributing to Colore

First off, thank you for considering contributing to Colore! Your contributions are highly appreciated.

How to Contribute

Reporting Bugs

If you find a bug in the source code, you can help by submitting an issue to the GitHub repository. Before you submit an issue, please search the issue tracker to see if someone has already reported the problem.

Suggesting Enhancements

If you have an idea to improve Colore, we would love to hear about it! Please check the existing enhancement issues to see if a similar suggestion has already been made. If not, feel free to create a new enhancement issue.

Pull Requests

  1. Fork the repository and clone it locally.
  2. Create a new branch for your work: 
    git checkout -b feature/my-feature
  3. Make your changes.
  4. Ensure all tests pass: 
    yarn test
  5. Commit your changes and push your branch to GitHub: 
    git commit -am 'Add new feature'
git push origin feature/my-feature
  6. Create a Pull Request from your branch to the main branch.

Code Style

Please follow the coding style used in the project. Make sure your code is properly formatted and linted:

yarn lint

Documentation

For significant changes, please ensure your contribution includes relevant documentation updates. Update the README.md file if the change is user-facing.

Community Expectations

We expect all contributors to adhere to our Code of Conduct. Be respectful and considerate in your interactions with other contributors.

Resources

Thank you for your contributions!