From c5e28b32e3cf59847c708c382e94a706c9132abc Mon Sep 17 00:00:00 2001 From: Justin Lowery Date: Tue, 27 Jun 2017 05:26:17 -0400 Subject: [PATCH] added contributing policy --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e264bbd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing + +Feel free to submit an issue or pull request. Each change will be considered based on the style and technical merits of the submitted solution or suggestion. + +## Issues + +When creating an issue, please be sure to include the following to ensure that your question can be answered: + +* A detailed description of the issue or question +* Steps taken to try and solve the issue or answer the question independently. If you are unsure of any steps to attempt, please say so. +* The version of Go being used +* The ```go-sortedmap``` commit ID of the code being used +* A complete, working, snippet of code that demonstrates the issue being brought up + +## Pull Requests + +* Ensure that your changes will benefit the project's userbase and will fit its purpose, without venturing out of scope. +* Make sure that the coding style of submitted pull requests matches the established coding style. +* Please do not submit pull requests that fail existing tests. +* Please create new tests for submitted work in order to keep code coverage at 100%. + +Thank you for reading and considering this policy. \ No newline at end of file