From 50521417630ae254a429c0bc7c64c6d9c5974ba7 Mon Sep 17 00:00:00 2001 From: Simeon Warner Date: Fri, 13 May 2016 20:21:29 -0400 Subject: [PATCH] Suggestions --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b0a9673 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Contributing to resync + +Issues and pull requests are appreciated. + +## Submitting issues + +In the case of bugs please describe in detail, preferably with a recipe to repeat and demonstrate the problem. Although you should include test data as necessary, please be careful not to include secrets or passwords! + +If you suggest a new feature, please give an example of expected behavior and use. For changes to modules and methods a tests case would be idea. + +## Coding style + +If submitting a pull request: + + * Please discuss in a issue before submitting a pull request for significant changes. + * Please follow [PEP8](https://www.python.org/dev/peps/pep-0008/) and [PEP257](https://www.python.org/dev/peps/pep-0257/) style rules. + * Please don't repeat code. + * Please cover the code with tests. +