Contributing #

Thank you for your interest in contributing! There are many ways to contribute to dt. You can start with examining unchecked items in the roadmap, or discuss some features to be added to the roadmap.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Making your changes #

1. Fork a copy of dt into your GitHub account and clone the forked repository to your development machine:

   $ git clone https://github.com/${your_account}/dt.git && cd dt
   

2. Install latest stable version of Rust, then make your commits. Please follow the conventional commit specification when writing your commit messages.
3. If features are added/updated, also add/update tests and documents and check if the tests are passed:

   $ cargo test
   

4. Resolve errors and warnings given by cargo-clippy:

   $ cargo clippy
   

5. Format your changes with cargo-fmt:

   $ cargo fmt -- --verbose
   

6. Submit a pull request and discuss the possible changes with the owner/maintainer, update your pull request if necessary.

License #

By contributing, you agree that your contributions will be licenced under MIT or Apache 2.0 license.