Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

28 lines (20 loc) · 1.44 KB

Contributing to Cameleon

Thank you for your interest in contributing to Cameleon! We are so happy to have you join the development.

Code of Conduct

We adopt Rust Code of Conduct for our all projects.
All contributors are expected to read and follow the Code of Conduct.

Bug reports

  • Please search for a related issue before opening an issue to avoid duplication
  • Please add minimal complete and verifiable examples if possible. This would be a great help for fixing the issue.

Finding something to fix/improve

The best way to dive into the development is to find and work on the issue labeled good first issue.

Pull Request process

Opening a related issue

Before writing a code, please open an issue to avoid wasted efforts.

Opening a PR

  1. Please make sure to run test_all.sh and ensure all tests are passed before opening a PR.
  2. Please fill out the PULL_REQUEST_TEMPLATE which is presented to you when you open a new PR.

In reviewing

You would get some feedback or change requests from the cameleon-rs members.

In case you need to change the code, please Do NOT squash or rebase the commits during the review process. The reviewer may squash your commits into one or several commits based on logical changes.