diff --git a/README.md b/README.md index 5f6abd0366..ff8a5f8716 100644 --- a/README.md +++ b/README.md @@ -134,7 +134,8 @@ The libp2p implementation in Nim is a work in progress. We welcome contributors - Go through the modules and **check out existing issues**. This would be especially useful for modules in active development. Some knowledge of IPFS/libp2p may be required, as well as the infrastructure behind it. - **Perform code reviews**. Feel free to let us know if you found anything that can a) speed up the project development b) ensure better quality and c) reduce possible future bugs. - **Add tests**. Help nim-libp2p to be more robust by adding more tests to the [tests folder](tests/). - +- **Small PRs**. Try to keep PRs atomic and digestible. This makes the review process and pinpointing bugs easier. +- **Code format**. Please format code using [nph](https://github.com/arnetheduck/nph). The code follows the [Status Nim Style Guide](https://status-im.github.io/nim-style-guide/). ### Contributors