Skip to content

Commit

Permalink
Added initial CONTRIBUTING.md guidness for TheDan64#11
Browse files Browse the repository at this point in the history
  • Loading branch information
TheDan64 committed Oct 25, 2017
1 parent 9737dfa commit 322cf13
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/CONTRIBUTING.md
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

0 comments on commit 322cf13

Please sign in to comment.