Add CONTRIBUTING.md guide #766
Conversation
|
I took inspiration from several different CONTRIBUTING.md but mainly from:
And consolidated the main elements to help someone begin contributing. |
|
|
||
| Reach out to `@Node Developers` in Discord in the [#development](https://discord.com/channels/599153230659846165/755890250643144788) channel. | ||
|
|
||
| Follow along the R&D Telegram group. |
There was a problem hiding this comment.
Should we add the link to the group here?
| ## Pull request guidelines | ||
|
|
||
| ### Before making a Pull Request: | ||
| - Run `cargo check` to make sure your code adheres to coding standards |
There was a problem hiding this comment.
Should we also add clippy?
Minimal: cargo clippy
Pedantic: cargo clippy -- -W clippy::pedantic
There was a problem hiding this comment.
The command that I personally run is:
cargo fmt; cargo clippy --all --tests --benches; cargo nextest run --release
| ## How to get started | ||
|
|
||
| 1. Find an issue (or open one) — good first issues are a great first step. | ||
| 2. Fork the repo and create a feature branch with a short, descriptive name. |
There was a problem hiding this comment.
We could maybe add backlink to README.md#Installation after "fork the repo"
| - Even if you can't read the code but know how to test it, do that too! Ask for information on how to test the change if it's missing from the PR and run it. | ||
| - Use Approve when you believe the change is correct and safe to merge. | ||
| - Use Request Changes when you find real issues; explain the issue and prefer actionable guidance. | ||
|
|
There was a problem hiding this comment.
In my opinion we should highlight this part, and have it be before "classical" contribution.
There was a problem hiding this comment.
see bitcoin core's analogue for comparison:
"Getting Started
New contributors are very welcome and needed.
Reviewing and testing is highly valued and the most effective way you can contribute as a new contributor. It also will teach you much more about the code and process than opening pull requests..."
|
I think we can take a lot more inspiration from the btc analogue I miss sections like |
3 participants
This aims to provide a document to make it clearer how newcomers can begin to contribute to Kaspa.