Skip to content

Commit

Permalink
phrasing
Browse files Browse the repository at this point in the history
  • Loading branch information
@mattsse
mattsse committed Oct 12, 2023
1 parent b6943be commit e1cbbe6
Showing 1 changed file with 106 additions and 51 deletions.
157 changes: 106 additions & 51 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

Thanks for your interest in improving Reth!

There are multiple opportunities to contribute at any level. It doesn't matter if you are just getting started with Rust or are the most weathered expert, we can use your help.
There are multiple opportunities to contribute at any level. It doesn't matter if you are just getting started with Rust
or are the most weathered expert, we can use your help.

**No contribution is too small and all contributions are valued.**

Expand All @@ -11,13 +12,16 @@ It should be considered as a guide to help you navigate the process.

The [dev Telegram][dev-tg] is available for any concerns you may have that are not covered in this guide.

If you contribute to this project, your contributions will be made to the project under both Apache 2.0 and the MIT license.
If you contribute to this project, your contributions will be made to the project under both Apache 2.0 and the MIT
license.

### Code of Conduct

The Reth project adheres to the [Rust Code of Conduct][rust-coc]. This code of conduct describes the _minimum_ behavior expected from all contributors.
The Reth project adheres to the [Rust Code of Conduct][rust-coc]. This code of conduct describes the _minimum_ behavior
expected from all contributors.

Instances of violations of the Code of Conduct can be reported by contacting the team at [georgios@paradigm.xyz](mailto:georgios@paradigm.xyz).
Instances of violations of the Code of Conduct can be reported by contacting the team
at [georgios@paradigm.xyz](mailto:georgios@paradigm.xyz).

### Ways to contribute

Expand All @@ -32,7 +36,8 @@ There are fundamentally three ways an individual can contribute:
by opening a pull request that fixes the underlying problem, in a concrete and
reviewable manner.

**Anybody can participate in any stage of contribution**. We urge you to participate in the discussion around bugs and participate in reviewing PRs.
**Anybody can participate in any stage of contribution**. We urge you to participate in the discussion around bugs and
participate in reviewing PRs.

### Asking for help

Expand All @@ -41,40 +46,49 @@ There are fundamentally three ways an individual can contribute:
<!-- - **Asking in the support Telegram:** The [Foundry Support Telegram][support-tg] is a fast and easy way to ask questions. -->
<!-- - **Opening a discussion:** This repository comes with a discussions board where you can also ask for help. Click the "Discussions" tab at the top. -->

If you have reviewed existing documentation and still have questions, or you are having problems, you can get help by **opening a discussion**. This repository comes with a discussions board where you can also ask for help. Click the "Discussions" tab at the top.
If you have reviewed existing documentation and still have questions, or you are having problems, you can get help by *
*opening a discussion**. This repository comes with a discussions board where you can also ask for help. Click the "
Discussions" tab at the top.

As Reth is still in heavy development, the documentation can be a bit scattered. The [Reth Book][reth-book] is our current best-effort attempt at keeping up-to-date information.
As Reth is still in heavy development, the documentation can be a bit scattered. The [Reth Book][reth-book] is our
current best-effort attempt at keeping up-to-date information.

### Submitting a bug report

When filing a new bug report in the issue tracker, you will be presented with a basic form to fill out.

If you believe that you have uncovered a bug, please fill out the form to the best of your ability. Do not worry if you cannot answer every detail, just fill in what you can. Contributors will ask follow-up questions if something is unclear.
If you believe that you have uncovered a bug, please fill out the form to the best of your ability. Do not worry if you
cannot answer every detail, just fill in what you can. Contributors will ask follow-up questions if something is
unclear.

The most important pieces of information we need in a bug report are:

- The Reth version you are on (and that it is up to date)
- The platform you are on (Windows, macOS, an M1 Mac or Linux)
- Code snippets if this is happening in relation to testing or building code
- Concrete steps to reproduce the bug
- The Reth version you are on (and that it is up to date)
- The platform you are on (Windows, macOS, an M1 Mac or Linux)
- Code snippets if this is happening in relation to testing or building code
- Concrete steps to reproduce the bug

In order to rule out the possibility of the bug being in your project, the code snippets should be as minimal as possible. It is better if you can reproduce the bug with a small snippet as opposed to an entire project!
In order to rule out the possibility of the bug being in your project, the code snippets should be as minimal as
possible. It is better if you can reproduce the bug with a small snippet as opposed to an entire project!

See [this guide][mcve] on how to create a minimal, complete, and verifiable example.

### Submitting a feature request

When adding a feature request in the issue tracker, you will be presented with a basic form to fill out.

Please include as detailed of an explanation as possible of the feature you would like, adding additional context if necessary.
Please include as detailed of an explanation as possible of the feature you would like, adding additional context if
necessary.

If you have examples of other tools that have the feature you are requesting, please include them as well.

### Resolving an issue

Pull requests are the way concrete changes are made to the code, documentation, and dependencies of Reth.

Even tiny pull requests, like fixing wording, are greatly appreciated. Before making a large change, it is usually a good idea to first open an issue describing the change to solicit feedback and guidance. This will increase the likelihood of the PR getting merged.
Even tiny pull requests, like fixing wording, are greatly appreciated. Before making a large change, it is usually a
good idea to first open an issue describing the change to solicit feedback and guidance. This will increase the
likelihood of the PR getting merged.

Please also make sure that the following commands pass if you have changed the code:

Expand All @@ -85,77 +99,99 @@ cargo +nightly fmt -- --check
cargo +nightly clippy --all --all-features -- -D warnings
```

If you are working in VSCode, we recommend you install the [rust-analyzer](https://rust-analyzer.github.io/) extension, and use the following VSCode user settings:
If you are working in VSCode, we recommend you install the [rust-analyzer](https://rust-analyzer.github.io/) extension,
and use the following VSCode user settings:

```json
"editor.formatOnSave": true,
"rust-analyzer.rustfmt.extraArgs": ["+nightly"],
"rust-analyzer.check.overrideCommand": [
"cargo",
"+nightly",
"clippy",
"--all",
"--all-features",
"--message-format=json"
"cargo",
"+nightly",
"clippy",
"--all",
"--all-features",
"--message-format=json"
],
"[rust]": {
"editor.defaultFormatter": "rust-lang.rust-analyzer"
"editor.defaultFormatter": "rust-lang.rust-analyzer"
}
```

If you are working on a larger feature, we encourage you to open up a draft pull request, to make sure that other contributors are not duplicating work.
If you are working on a larger feature, we encourage you to open up a draft pull request, to make sure that other
contributors are not duplicating work.

#### Adding tests

If the change being proposed alters code, it is either adding new functionality to Reth, or fixing existing, broken functionality.
In both of these cases, the pull request should include one or more tests to ensure that Reth does not regress in the future.
If the change being proposed alters code, it is either adding new functionality to Reth, or fixing existing, broken
functionality.
In both of these cases, the pull request should include one or more tests to ensure that Reth does not regress in the
future.

Types of tests include:

- **Unit tests**: Functions which have very specific tasks should be unit tested.
- **Integration tests**: For general purpose, far reaching functionality,
integration tests should be added. The best way to add a new integration test is to look at existing ones and follow the style.
- **Unit tests**: Functions which have very specific tasks should be unit tested.
- **Integration tests**: For general purpose, far reaching functionality,
integration tests should be added. The best way to add a new integration test is to look at existing ones and follow
the style.

Tests that use forking must contain "fork" in their name.
#### Running Individual tests

To execute only the tests in an individual file, e.g. `trace.rs`, navigate to the directory of that file (`reth/crates/rpc/rpc/src`) and execute the following command. Where "`trace`" is the name of the file containing the tests you'd like to run.
By default, `cargo test` does not select any packages, in order to run individual tests by name (
e.g. `cargo test mytest`) navigate to the directory of that file (e.g. `reth/crates/rpc/rpc/`) or use
the `-p <package-name>` option to run specific tests of a crate from anywhere in the
workspace (`cargo test -p reth-rpc mytest`).

```
cargo test trace
```
See also [cargo-test](https://doc.rust-lang.org/cargo/commands/cargo-test.html) for more information on running tests.

#### Commits

It is a recommended best practice to keep your changes as logically grouped as possible within individual commits. There is no limit to the number of commits any single pull request may have, and many contributors find it easier to review changes that are split across multiple commits.
It is a recommended best practice to keep your changes as logically grouped as possible within individual commits. There
is no limit to the number of commits any single pull request may have, and many contributors find it easier to review
changes that are split across multiple commits.

That said, if you have a number of commits that are "checkpoints" and don't represent a single logical change, please squash those together.
That said, if you have a number of commits that are "checkpoints" and don't represent a single logical change, please
squash those together.

#### Opening the pull request

From within GitHub, opening a new pull request will present you with a template that should be filled out. Please try your best at filling out the details, but feel free to skip parts if you're not sure what to put.
From within GitHub, opening a new pull request will present you with a template that should be filled out. Please try
your best at filling out the details, but feel free to skip parts if you're not sure what to put.

#### Discuss and update

You will probably get feedback or requests for changes to your pull request.
This is a big part of the submission process, so don't be discouraged! Some contributors may sign off on the pull request right away, others may have more detailed comments or feedback. This is a necessary part of the process in order to evaluate whether the changes are correct and necessary.
This is a big part of the submission process, so don't be discouraged! Some contributors may sign off on the pull
request right away, others may have more detailed comments or feedback. This is a necessary part of the process in order
to evaluate whether the changes are correct and necessary.

**Any community member can review a PR, so you might get conflicting feedback**. Keep an eye out for comments from code owners to provide guidance on conflicting feedback.
**Any community member can review a PR, so you might get conflicting feedback**. Keep an eye out for comments from code
owners to provide guidance on conflicting feedback.

#### Reviewing pull requests

**Any Reth community member is welcome to review any pull request**.

All contributors who choose to review and provide feedback on pull requests have a responsibility to both the project and individual making the contribution. Reviews and feedback must be helpful, insightful, and geared towards improving the contribution as opposed to simply blocking it. If there are reasons why you feel the PR should not be merged, explain what those are. Do not expect to be able to block a PR from advancing simply because you say "no" without giving an explanation. Be open to having your mind changed. Be open to working _with_ the contributor to make the pull request better.
All contributors who choose to review and provide feedback on pull requests have a responsibility to both the project
and individual making the contribution. Reviews and feedback must be helpful, insightful, and geared towards improving
the contribution as opposed to simply blocking it. If there are reasons why you feel the PR should not be merged,
explain what those are. Do not expect to be able to block a PR from advancing simply because you say "no" without giving
an explanation. Be open to having your mind changed. Be open to working _with_ the contributor to make the pull request
better.

Reviews that are dismissive or disrespectful of the contributor or any other reviewers are strictly counter to the [Code of Conduct][coc-header].
Reviews that are dismissive or disrespectful of the contributor or any other reviewers are strictly counter to
the [Code of Conduct][coc-header].

When reviewing a pull request, the primary goals are for the codebase to improve and for the person submitting the request to succeed. **Even if a pull request is not merged, the submitter should come away from the experience feeling like their effort was not unappreciated**. Every PR from a new contributor is an opportunity to grow the community.
When reviewing a pull request, the primary goals are for the codebase to improve and for the person submitting the
request to succeed. **Even if a pull request is not merged, the submitter should come away from the experience feeling
like their effort was not unappreciated**. Every PR from a new contributor is an opportunity to grow the community.

##### Review a bit at a time

Do not overwhelm new contributors.

It is tempting to micro-optimize and make everything about relative performance, perfect grammar, or exact style matches. Do not succumb to that temptation.
It is tempting to micro-optimize and make everything about relative performance, perfect grammar, or exact style
matches. Do not succumb to that temptation.

Focus first on the most significant aspects of the change:

Expand All @@ -164,32 +200,51 @@ Focus first on the most significant aspects of the change:
3. Are there clear bugs or larger scale issues that need attending?
4. Are the commit messages readable and correct? If it contains a breaking change, is it clear enough?

Note that only **incremental** improvement is needed to land a PR. This means that the PR does not need to be perfect, only better than the status quo. Follow-up PRs may be opened to continue iterating.
Note that only **incremental** improvement is needed to land a PR. This means that the PR does not need to be perfect,
only better than the status quo. Follow-up PRs may be opened to continue iterating.

When changes are necessary, _request_ them, do not _demand_ them, and **do not assume that the submitter already knows how to add a test or run a benchmark**.
When changes are necessary, _request_ them, do not _demand_ them, and **do not assume that the submitter already knows
how to add a test or run a benchmark**.

Specific performance optimization techniques, coding styles and conventions change over time. The first impression you give to a new contributor never does.
Specific performance optimization techniques, coding styles and conventions change over time. The first impression you
give to a new contributor never does.

Nits (requests for small changes that are not essential) are fine, but try to avoid stalling the pull request. Most nits can typically be fixed by the Reth maintainers merging the pull request, but they can also be an opportunity for the contributor to learn a bit more about the project.
Nits (requests for small changes that are not essential) are fine, but try to avoid stalling the pull request. Most nits
can typically be fixed by the Reth maintainers merging the pull request, but they can also be an opportunity for the
contributor to learn a bit more about the project.

It is always good to clearly indicate nits when you comment, e.g.: `Nit: change foo() to bar(). But this is not blocking`.
It is always good to clearly indicate nits when you comment,
e.g.: `Nit: change foo() to bar(). But this is not blocking`.

If your comments were addressed but were not folded after new commits, or if they proved to be mistaken, please, [hide them][hiding-a-comment] with the appropriate reason to keep the conversation flow concise and relevant.
If your comments were addressed but were not folded after new commits, or if they proved to be mistaken,
please, [hide them][hiding-a-comment] with the appropriate reason to keep the conversation flow concise and relevant.

##### Be aware of the person behind the code

Be aware that _how_ you communicate requests and reviews in your feedback can have a significant impact on the success of the pull request. Yes, we may merge a particular change that makes Reth better, but the individual might just not want to have anything to do with Reth ever again. The goal is not just having good code.
Be aware that _how_ you communicate requests and reviews in your feedback can have a significant impact on the success
of the pull request. Yes, we may merge a particular change that makes Reth better, but the individual might just not
want to have anything to do with Reth ever again. The goal is not just having good code.

##### Abandoned or stale pull requests

If a pull request appears to be abandoned or stalled, it is polite to first check with the contributor to see if they intend to continue the work before checking if they would mind if you took it over (especially if it just has nits left). When doing so, it is courteous to give the original contributor credit for the work they started, either by preserving their name and e-mail address in the commit log, or by using the `Author: ` or `Co-authored-by: ` metadata tag in the commits.
If a pull request appears to be abandoned or stalled, it is polite to first check with the contributor to see if they
intend to continue the work before checking if they would mind if you took it over (especially if it just has nits
left). When doing so, it is courteous to give the original contributor credit for the work they started, either by
preserving their name and e-mail address in the commit log, or by using the `Author: ` or `Co-authored-by: ` metadata
tag in the commits.

_Adapted from the [Foundry contributing guide][foundry-contributing]_.

[rust-coc]: https://github.com/rust-lang/rust/blob/master/CODE_OF_CONDUCT.md

[coc-header]: #code-of-conduct

[dev-tg]: https://t.me/paradigm_reth

[reth-book]: https://github.com/paradigmxyz/reth/tree/main/book

[mcve]: https://stackoverflow.com/help/mcve

[hiding-a-comment]: https://help.github.com/articles/managing-disruptive-comments/#hiding-a-comment

[foundry-contributing]: https://github.com/foundry-rs/foundry/blob/master/CONTRIBUTING.md

0 comments on commit e1cbbe6

Please sign in to comment.