-
Notifications
You must be signed in to change notification settings - Fork 403
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: John Guibas <[email protected]>
- Loading branch information
Showing
1 changed file
with
165 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,165 @@ | ||
| ## Contributing to SP1 | ||
|
|
||
| Thanks for your interest in improving SP1! | ||
|
|
||
| There are multiple opportunities to contribute at any level. It doesn't matter if you are just getting started with Rust | ||
| or an expert, we can use your help. | ||
|
|
||
| **No contribution is too small and all contributions are valued.** | ||
|
|
||
| This document will help you get started. **Do not let the document intimidate you**. | ||
| It should be considered as a guide to help you navigate the process. | ||
|
|
||
| The [Telegram](https://t.me/succinct_sp1) 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. | ||
|
|
||
| ### Code of Conduct | ||
|
|
||
| The SP1 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. | ||
|
|
||
| ### Ways to contribute | ||
|
|
||
| There are fundamentally three ways an individual can contribute: | ||
|
|
||
| 1. **By opening an issue:** For example, if you believe that you have uncovered a bug | ||
| in SP1, creating a new issue in the issue tracker is the way to report it. | ||
| 2. **By adding context:** Providing additional context to existing issues, | ||
| such as screenshots and code snippets to help resolve issues. | ||
| 3. **By resolving issues:** Typically this is done in the form of either | ||
| demonstrating that the issue reported is not a problem after all, or more often, | ||
| 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. | ||
|
|
||
| ### Contributions Related to Spelling and Grammar | ||
|
|
||
| At this time, we will not be accepting contributions that only fix spelling or grammatical errors in documentation, code or | ||
| elsewhere. | ||
|
|
||
| ### Asking for help | ||
|
|
||
| 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 SP1 is still in heavy development, the documentation can be a bit scattered. The [SP1 Book](https://succinctlabs.github.io/sp1/) is our | ||
| current best-effort attempt at keeping up-to-date information. | ||
|
|
||
| ### Submitting a bug report | ||
|
|
||
| The most important pieces of information we need in a bug report are: | ||
|
|
||
| - The SP1 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! | ||
|
|
||
| See [this guide][mcve] on how to create a minimal, complete, and verifiable example. | ||
|
|
||
| ### Submitting a feature request | ||
|
|
||
| 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 SP1. | ||
|
|
||
| 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. | ||
|
|
||
| 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 SP1, or fixing existing, broken | ||
| functionality. | ||
| In both of these cases, the pull request should include one or more tests to ensure that SP1 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. | ||
|
|
||
| #### 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. | ||
|
|
||
| #### 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. | ||
|
|
||
| #### 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. | ||
|
|
||
| **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 SP1 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. | ||
|
|
||
| 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. | ||
|
|
||
| ##### 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 SP1 better, but the individual might just not | ||
| want to have anything to do with SP1 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. | ||
|
|
||
| _Adapted from the [Reth contributing guide](https://raw.githubusercontent.com/paradigmxyz/reth/main/CONTRIBUTING.md)_. | ||
|
|
||
| [rust-coc]: https://github.com/rust-lang/rust/blob/master/CODE_OF_CONDUCT.md | ||
|
|
||
| [coc-header]: #code-of-conduct | ||
|
|
||
| [mcve]: https://stackoverflow.com/help/mcve | ||
|
|
||
| [hiding-a-comment]: https://help.github.com/articles/managing-disruptive-comments/#hiding-a-comment |