From e7f700ae4724be8f11fac848e650f0d7907096e5 Mon Sep 17 00:00:00 2001 From: kaiserd <1684595+kaiserd@users.noreply.github.com> Date: Fri, 10 May 2024 14:48:14 +0200 Subject: [PATCH 1/3] chore(README): small PRs Add a line on small PRs to the contribute section of the README. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 5f6abd0366..42df893e3b 100644 --- a/README.md +++ b/README.md @@ -134,6 +134,7 @@ 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. The code follows the [Status Nim Style Guide](https://status-im.github.io/nim-style-guide/). From 31df3a3f6916bbb8b87030332f19653b02975f1a Mon Sep 17 00:00:00 2001 From: kaiserd <1684595+kaiserd@users.noreply.github.com> Date: Wed, 15 May 2024 19:05:11 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 42df893e3b..1cf25c193d 100644 --- a/README.md +++ b/README.md @@ -135,7 +135,7 @@ The libp2p implementation in Nim is a work in progress. We welcome contributors - **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 From e227d1bd10e0bf23fa1d30c2c78ef15236006867 Mon Sep 17 00:00:00 2001 From: kaiserd <1684595+kaiserd@users.noreply.github.com> Date: Wed, 15 May 2024 19:05:36 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1cf25c193d..ff8a5f8716 100644 --- a/README.md +++ b/README.md @@ -135,7 +135,7 @@ The libp2p implementation in Nim is a work in progress. We welcome contributors - **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). +- **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