Update contributing guidelines (#2563)

* update contributing guidelines * add pull request template
2019-02-19 14:29:58 +00:00
parent 48b7421d1e
commit b1c09946cb
2 changed files with 35 additions and 1 deletions
@@ -0,0 +1,18 @@
+---
+name: Pull Request
+about: Pull Request checklist
+title: ''
+labels: ''
+assignees: ''
+
+---
+If your PR is a work in progress, please feel free to create it and include a [WIP] tag in the PR name. We encourage everyone to PR early and often so that other developers know what you're working on.
+
+Before submitting your PR for final review, please ensure that it:
+
+* Includes a proper description of what problems the PR addresses, as well as a detailed explanation as to what it changes
+* Explains whether/how the change is consensus breaking or breaks existing client functionality
+* Contains unit tests exercising new/changed functionality
+* Fully considers the potential impact of the change on other parts of the system
+* Describes how you've tested the change (e.g. against Floonet, etc)
+* Updates any documentation that's affected by the PR