From 18dc233c9bb2e4f70e182e350715ca9148e62ce5 Mon Sep 17 00:00:00 2001 From: Jacek Sieka Date: Fri, 10 Dec 2021 10:11:52 +0100 Subject: [PATCH] link to style guide --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 2a28afd..e61d1e3 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,7 @@ nimble install # run all the unit tests nimble test ``` +The code follows the [Status Nim Style Guide](https://status-im.github.io/nim-style-guide/). ### Packages @@ -166,11 +167,14 @@ nim c -d:KnownLibP2PTopics=topic1,topic2,topic3 some_file.nim ``` ## Contribute + The libp2p implementation in Nim is a work in progress. We welcome contributors to help out! Specifically, you can: - 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](https://github.com/status-im/nim-libp2p/tree/master/tests). +The code follows the [Status Nim Style Guide](https://status-im.github.io/nim-style-guide/). + ### Core Developers [@cheatfate](https://github.com/cheatfate), [Dmitriy Ryajov](https://github.com/dryajov), [Giovanni Petrantoni](https://github.com/sinkingsugar), [Zahary Karadjov](https://github.com/zah)