Anyone is welcome to contribute to Oar. Here is how to do so:
Fork the repo, then clone it:
git clone git@github.com:yourusernamehere/oar.git && cd oar
git checkout -b my-new-feature-branch
cargo buildNow apply any changes to the source code. Make sure to abide by the following rules:
- Use tabs for indentation and alignment
- Keep indentation on blank lines
- Keep code and documentation professional: avoid swear words for example
- Always leave the campsite cleaner than you found it
When you have made your changes check that the code successfully builds and unit tests pass:
cargo testManually check it works:
oartmp=$(mktemp)
cat /usr/share/dict/words > $oartmp
cargo run $oartmp
rm $oartmpLint it:
cargo clippy -- -D warningsCommit it:
git add src/
git commit -m "Description of the feature"
git push --set-upstream origin my-new-feature-branchCreate a pull request:
https://github.com/yourusernamehere/oar/pull/new/my-new-feature-branch
-
Running clippy can sometimes fail with "
caused by: Compiler not supported". To fix run like:RUSTC_WRAPPER="" cargo clippy -- -D warnings. -
If errors are being printed to stderr but you cannot see them due to the terminal rendering on stdout, try running with
2>&1 >/dev/nullto ignore all stdout.