File tree 1 file changed +30
-0
lines changed
1 file changed +30
-0
lines changed Original file line number Diff line number Diff line change
1
+ # Contributing to commit
2
+ We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
3
+
4
+ - Reporting a bug
5
+ - Discussing the current state of the code
6
+ - Submitting a fix
7
+ - Proposing new features
8
+
9
+ ## Write bug reports with detail
10
+
11
+ ** Great Bug Reports** tend to have:
12
+
13
+ - A quick summary and/or background
14
+ - Steps to reproduce
15
+ - Be specific!
16
+ - What you expected would happen
17
+ - What actually happens
18
+ - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
19
+
20
+ ## Contributing with code
21
+
22
+ 1 . Fork the repo and create your branch from ` main ` .
23
+ 2 . If you've added code that should be tested, add tests.
24
+ 3 . If you've changed user interface or configuration file code, update the documentation
25
+ 4 . Ensure the test suite passes, run ` cargo test ` to run the tests
26
+ 5 . Make sure your code lints, run ` cargo fmt ` to format the code and follow the lint rules with ` cargo clippy ` .
27
+ 6 . Issue that pull request!
28
+
29
+ ## License
30
+ By contributing, you agree that your contributions will be licensed under its MIT License.
You can’t perform that action at this time.
0 commit comments