Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

56 lines (38 loc) · 1.64 KB

Contributing to auto-palette

This project welcomes contributions from the community. Below are guidelines on how to participate effectively.
Please note that this project is released with a CODE_OF_CONDUCT. By participating in this project you agree to abide by its terms.

Issues

This project uses GitHub issues to track bugs and enhancement requests. Please search the existing issues before filing new issues to avoid duplicates.

Pull Requests

Please follow these steps to contribute to the project:

  1. ::Fork and clone the repository:**
git clone git@github.com:t28hub/auto-palette.git
  1. Create a new branch for your feature or bug fix:
git checkout -b your-branch-name
  1. Make your changes and write tests.
  2. Test your changes:
cargo nextest run --lib
  1. Try your changes with the example:
cargo run --example basic
  1. Ensure your changes do not break any existing functionality.
  2. Update the documentation if necessary.
  3. Create a pull request.

Code Style

Please follow the existing code style in the project. This project uses rustfmt for Rust code formatting and taplo for TOML code formatting. Ensure consistency by following general Rust style guidelines, and run the following commands before creating a pull request:

cargo +nightly fmt --all
taplo fmt

License

By contributing to this project, you agree that your contributions will be licensed under the LICENSE file in this repository.