File tree 1 file changed +41
-0
lines changed
1 file changed +41
-0
lines changed Original file line number Diff line number Diff line change
1
+ # Contributing to Trevm
2
+
3
+ :balloon : Thanks for your help improving the project! We are so happy to have
4
+ you!
5
+
6
+ ## Conduct
7
+
8
+ This repo adheres to the [ Rust Code of Conduct] [ coc ] . This describes
9
+ the _ minimum_ behavior expected from all contributors. Failure to maintain civil
10
+ behavior will result in a ban.
11
+
12
+ [ coc ] : https://www.rust-lang.org/policies/code-of-conduct
13
+
14
+ ## Pull Requests
15
+
16
+ Before making a large change, it is usually a good idea to first open an issue
17
+ describing the change to solicit feedback and guidance. This will increase the
18
+ likelihood of the PR getting merged.
19
+
20
+ When opening a PR ** please select the "Allow Edits From Maintainers" option** .
21
+ We maintain code quality and style standards, and require commit signing. This
22
+ option allows us to make small changes to your PR to bring it in line with
23
+ these standards. It helps us get your PR in faster, and with less work from you.
24
+
25
+ ## Development Basics
26
+
27
+ Before submitting a PR we recommend you run the following commands to ensure
28
+ your code is properly formatted and passes all tests:
29
+
30
+ ``` sh
31
+ cargo +nightly fmt --all
32
+ cargo clippy --all-features
33
+ cargo test --all-features
34
+ cargo test --no-default-features
35
+ ```
36
+
37
+ ### Contributions Related to Spelling, Grammar, and other trivial changes
38
+
39
+ At this time, we will not be accepting contributions that only fix spelling or
40
+ grammatical errors in documentation, code or
41
+ elsewhere.
You can’t perform that action at this time.
0 commit comments