Skip to content

Commit 322cf13

Browse files
committed
Added initial CONTRIBUTING.md guidness for rust-lang#11
1 parent 9737dfa commit 322cf13

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

.github/CONTRIBUTING.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contributing to Inkwell
2+
3+
Hello there! Thank you for taking interest in Inkwell!
4+
5+
## Found a Bug?
6+
7+
* Please ensure the bug was not already reported by searching our [issue tracker](https://github.com/TheDan64/inkwell/issues).
8+
* If you're unable to find an open issue relating to the problem, please file an [issue](https://github.com/TheDan64/inkwell/issues/new).
9+
10+
<!--- * Please use the issue template to create the issue --->
11+
12+
## Want to Submit a Pull Request?
13+
14+
* Please ensure your PR follows these guidelines:
15+
16+
### Required
17+
18+
* My code follows the code style of this project
19+
* I have added documentation and doc tests to any new functions or types
20+
* I have updated documentation and doc tests to any modified functions or types as applicable
21+
* I have added tests to cover my changes
22+
* All new and existing tests passed
23+
24+
### Desired
25+
26+
* I have ran clippy and updated portions of code pertaining to my changes
27+
28+
## Got Questions?
29+
30+
Please attempt to ask your question at our [Gitter Chat Room](https://gitter.im/inkwell-rs/Lobby). If no one gets back to you in a day or so, feel free to open up an issue.
31+
32+
Thanks!!
33+
34+
Inkwell Team

0 commit comments

Comments
 (0)