chore: Add detailed contributing informations #875
Conversation
romac
force-pushed
the
romac/contributing
branch
from
04eaadd to
179fa2a
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## main #875 +/- ##
=======================================
Coverage 82.64% 82.64%
=======================================
Files 187 187
Lines 16088 16088
=======================================
Hits 13295 13295
Misses 2793 2793
Flags with carried forward coverage won't be shown. Click here to find out more.
|
| cargo install cargo-nextest | ||
| ``` | ||
|
|
||
| 6. **Fork and clone the repository**: |
There was a problem hiding this comment.
Nit: We can just say "Clone the repo" and keep this step simpler. We would also replace 'USERNAME' with 'informalsystems' in the git clone command.
There was a problem hiding this comment.
Someone cannot contribute if they do not fork and clone the repository, so I would probably leave those steps as is. I can add a note that if one just wants to play around with the code and not submit PRs directly, they can clone the repo directly and give the command.
| For macOS: | ||
|
|
||
| ```bash | ||
| brew install protobuf |
There was a problem hiding this comment.
Might be useful to say which of the tests requires this dependency. Or is it 'cargo build' ?
There was a problem hiding this comment.
Yeah it's for building the Malachite apps.
Closes: #874
PR author checklist
For all contributors
For external contributors