Hacking and contributing

Hacking

• git checkout master; git pull; git checkout -b feature/my_branch
• change code
• add tests for new code
• cargo test --all
• All good? make +rustfmt happy, then submit a Pull Request on github (google for good guides on how github PR's work)

And why not try running your own little grin network? See the local net documentation

Testing

Preparations

cargo install cargo-check
cargo install cargo-cov
cargo install cargo-tarpaulin

Run

Run a quick syntax check with cargo check Run the full test suite with cargo test --all Run a test coverage analysis with cargo cov test

Troubleshooting

• Q: cargo cov test gives error error: Native profiler library not found A: Install clang with sudo apt-get install clang or similar.
• Q: cargo cov test fails, something about not finding nix/ptrace (something? or maybe not) A: Maybe try to rustup update. Maybe also try rust nightly, with something like rustup default nightly-x86_64-apple-darwin and see if that helps; and probably good to afterwards change back to stable, with something like rustup default stable-x86_64-apple-darwin

Contribution Ideas

Issues tagged good first issue are a good place to start if you're looking for something to help you get familiar with Rust or the Grin Codebase.

Issues tagged help wanted are often large features or projects, if you're looking for something substantial to dig your teeth into!