Skip to content

Latest commit

 

History

History
75 lines (41 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

75 lines (41 loc) · 1.99 KB
Raw

Contributing to ColorBuddy

First of all, thank you for considering contributing to colorbuddy. Your contributions will help make the project better and are greatly appreciated.

How to Contribute

Prerequisites

  • Git
  • Rust

Step 1: Fork the repository

Fork the upstream repository to your own GitHub account.

Step 2: Clone the forked repository

Clone the forked repository to your local machine:

git clone https://github.com/[Your User]/colorbuddy.git

Step 3: Create a branch

Create a new branch for the changes you want to make:

git checkout -b [branch-name]

Step 4: Make changes

Make the changes you want to contribute to the project. Ensure that your code is properly formatted and has adequate comments, documentation, and tests where necessary.

Step 5: Commit your changes

Please use cargo fmt, cargo clippy, and cargo test before committing (if not before..).

Commit your changes to the branch:

git commit -m "[descriptive message]"

Step 6: Push your changes

Push your changes to your forked repository:

git push origin [branch-name]

Step 7: Open a Pull Request

Go to the upstream repository on GitHub and open a new pull request (PR) against the master branch. In the pull request description, provide a brief summary of the changes you have made and the reasons behind them.

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.

License

colorbuddy is released under the license used by the upstream repository.

Contact

If you have any questions about the project or the contributing process, feel free to contact the maintainers.

Thank You

Thank you for your contributions to colorbuddy. We look forward to reviewing your pull request!