CONTRIBUTING.md

Contributing

Welcome, we really appreciate if you're considering to contribute to dra!

Development

1. Fork this repo
2. Clone your forked repo

   git clone https://github.com/<username>/dra && cd dra
   

3. Create a new branch
4. Install Rust >= 1.56.0 and run make install-components to install rustfmt and clippy
5. Build project with make build

Other make targets:

• test: run unit tests
• integration-tests: run integration tests. Read the docs for more info.
• format: format code with rustfmt
• format-check: check code is properly formatted
• lint: run cargo-clippy

Code style

• Always format the code with rustfmt

• Split your changes into separate atomic commits (where the build, tests and the system are all functioning).

• Make sure your commits are rebased on the main branch.

• The commit message must have the format "category: brief description". The category should be the name of a rust module or directory.

  See this commits for reference:

  • cli: add docs comment for --output option
  • ci: only run when something is pushed to main branch

Cross compilation

Install cross to cross compile.

Export these environment variables:

export CARGO_BIN=cross
# Change CARGO_TARGET value with the desired target (https://doc.rust-lang.org/rustc/platform-support.html)
export CARGO_TARGET=arm-unknown-linux-gnueabihf

Then you can build and test (only unit tests) by running:

make build
make test

Create an issue

Before submitting a new issue, please search the issues to make sure there isn't a similar issue that already exist.

License

By contributing, you agree that your contributions will be licensed under MIT License.