Skip to content
This repository was archived by the owner on Dec 1, 2025. It is now read-only.

Commit 87e52d6

Browse files
add guidelines for trivial contributions (#323)
1 parent 2141a3d commit 87e52d6

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

README.org

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,21 @@ It offers all the tools to:
66
2. Parse, compile down to polynomial arithmetic, and serialize constraint systems written in Corset Lisp;
77
3. Export those constraint systems in many formats, from Go to LaTeX;
88
4. Check & debug traces against a compiled constraint system.
9+
10+
* How to contribute
11+
12+
Contributions are welcome!
13+
14+
Guidelines for Non-Code and other Trivial Contributions
15+
Please keep in mind that we do not accept non-code contributions like fixing comments, typos or some other trivial fixes. Although we appreciate the extra help, managing lots of these small contributions is unfeasible, and puts extra pressure in our continuous delivery systems (running all tests, etc). Feel free to open an issue pointing to any of those errors, and we will batch them into a single change.
16+
17+
1. [Create an issue](https://github.com/Consensys/corset/issues).
18+
> If the proposed update requires input, also tag us for discussion.
19+
2. Submit the update as a pull request from your [fork of this repo](https://github.com/Consensys/corset/fork), and tag us for review.
20+
> Include the issue number in the pull request description and (optionally) in the branch name.
21+
22+
Consider starting with a ["good first issue"](https://github.com/Consensys/corset/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
23+
924
* Installation
1025
The only dependency to run Corset is [[https://www.rust-lang.org/][the Rust compiler]]. Once it is available, Corset can be installed with ~cargo install --git https://github.com/ConsenSys/corset~; or, within a local copy of the repo: ~cargo install --path .~
1126
* Usage

0 commit comments

Comments
 (0)