forked from TheDan64/inkwell
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added initial CONTRIBUTING.md guidness for TheDan64#11
- Loading branch information
Showing
1 changed file
with
34 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,34 @@ | ||
# Contributing to Inkwell | ||
|
||
Hello there! Thank you for taking interest in Inkwell! | ||
|
||
## Found a Bug? | ||
|
||
* Please ensure the bug was not already reported by searching our [issue tracker](https://github.com/TheDan64/inkwell/issues). | ||
* If you're unable to find an open issue relating to the problem, please file an [issue](https://github.com/TheDan64/inkwell/issues/new). | ||
|
||
<!--- * Please use the issue template to create the issue ---> | ||
|
||
## Want to Submit a Pull Request? | ||
|
||
* Please ensure your PR follows these guidelines: | ||
|
||
### Required | ||
|
||
* My code follows the code style of this project | ||
* I have added documentation and doc tests to any new functions or types | ||
* I have updated documentation and doc tests to any modified functions or types as applicable | ||
* I have added tests to cover my changes | ||
* All new and existing tests passed | ||
|
||
### Desired | ||
|
||
* I have ran clippy and updated portions of code pertaining to my changes | ||
|
||
## Got Questions? | ||
|
||
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. | ||
|
||
Thanks!! | ||
|
||
Inkwell Team |