Create CONTRIBUTING.md

mattpolzin · May 11, 2020 · 58304ce · 58304ce
1 parent 5c18f9c
commit 58304ce
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,11 @@
+Thank you for considering contributing to OpenAPIKit!
+
+Take a look at the [Code of Conduct](https://github.com/mattpolzin/OpenAPIKit/blob/master/CODE_OF_CONDUCT.md) and note the [MIT license](https://github.com/mattpolzin/OpenAPIKit/blob/master/LICENSE.txt) associated with this project.
+
+Please do the following in the course of preparing a branch and pull request for this project.
+
+- Create an issue motivating the changes you've made if one does not already exist. If you are unsure of how to adress an issue, seek out converstation on the issue before committing to a strategy.
+- Add test cases that cover the logical branches of your addition. For bug fixes, at least one of your test cases should fail prior to your change to serve as a regression test against the bug being fixed.
+- If relevant, cite the OpenAPI specification in describing your changes.
+
+Thanks!