Contributor Guide

Edit on Github

How to help with funding

We have a donation box set up at address 0x6CC55c39f51a2Da7D2DB5F2c4AAD133eb1418C4f.

We use funds from donations to:

  • fund bounties
  • fund audits of our production code
  • fund hardware on which to build Nimbus for you, from Raspberry Pis to feature phones

If you’d like to donate a conditional amount, i.e. one that depends on a certain milestone or deadline, please get in touch.

How To Get Involved with Nimbus’ development

To configure your setup for development:

git clone https://github.com/status-im/nimbus
cd nimbus
make update deps
./env.sh bash # configures your environment with dependencies like a locally installed Nim, etc.

Build and start hacking!

Thought Experiments

If you have research ideas you’d like to throw at us, exotic hardware you’d like to test on, or anything else revolutionary cooking up in your mind that you think might be bite too big for Geth or Parity to chew, let us know. We’ll gladly experiment!

Testing

You can join a testnet by following instructions here.

Guidelines

Whatever you might expect to see in other projects applies here:

  • be nice to others
  • when evaluating PRs, focus exclusively on the quality of the code
  • if submitting code, make sure it’s tested. All code MUST come with tests. To speed up the review, ping a team member.
  • if submitting typo fixes or documentation changes, speed up the review process by pinging a team member. Swader will usually review those very quickly.
  • if submitting a tutorial for inclusion on the official blog, also feel free to ping Swader.