Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

48 lines (30 loc) · 2.08 KB

Contributing Guidelines

Thank you for considering contributing to our project! We welcome your contributions in the form of code, bug reports, feature requests, or documentation improvements. To ensure a smooth collaboration process, please follow the guidelines below.

Installation and Setup

Before getting started, please make sure you have completed the following steps:

  1. Install the latest version of Rust.
  2. Clone the project repository to your local machine: git clone https://github.com/JiatLn/color-art.
  3. Run cargo test to make sure everything is working.
  4. Start coding! ❤️

Contribution Process

We appreciate contributions in the following forms:

Submitting Issues

If you encounter any problems or have suggestions for improvement, please create a new issue. Include as much information as possible, along with relevant examples or error messages, to help us understand and address the issue.

Branch Management

  • The main branch is the main branch for stable releases.
  • Please create feature branches based on main using the naming convention feature/your-feature-name.

Committing Code

  1. Develop your code on your own feature branch.
  2. Write clear and concise code with consistent naming and proper comments.
  3. Before committing your changes, make sure to run all relevant tests and pass them.
  4. Send a Pull Request, providing a detailed description of your changes and the purpose behind them.

Code Review Process

We encourage all contributors to participate in the code review process. During the review, we will assess the quality, logic, documentation, and other relevant aspects of the code. Please be patient and address any feedback or comments received.

Copyright and License

This project is released under the MIT License. By contributing to this project, you agree to comply with the license requirements.

If you have any questions about the contribution process or need further assistance, please create an issue, and we will do our best to help.

Thank you for your contributions and support!