CONTRIBUTING.md

How to contribute to Rust client library for Central Dogma project

First of all, thank you so much for taking your time to contribute! This project is not very different from any other open source projects you are aware of. It will be amazing if you could help us by doing any of the following:

• File an issue in the issue tracker to report bugs and propose new features and improvements.
• Ask a question by creating a new issue in the issue tracker.
  • Browse the list of previously answered questions.
• Contribute your work by sending a pull request.

Run test suite

Run local centraldogma server with docker-compose

docker-compose up -d

Run all tests

cargo test

Run unit test only (centraldogma server not needed)

cargo test --lib

Contributor license agreement

When you are sending a pull request and it's a non-trivial change beyond fixing typos, please sign the ICLA (individual contributor license agreement).
Note that this ICLA covers Central Dogma project and its subprojects, which means you can contribute to line/centraldogma and line/centraldogma-rs at once by signing this ICLA. Please contact us if you need the CCLA (corporate contributor license agreement).

Code of conduct

We expect contributors to follow our code of conduct.