Some more notes

This commit is contained in:
Simeon Warner 2017-08-30 13:32:30 -04:00
parent cd5e9ce826
commit 4eaae3282d

View File

@ -1,6 +1,6 @@
# Contributing to resync
Issues and pull requests are appreciated.
Issues and pull requests are appreciated. I apologize if it takes me some time to respond to issues.
## Submitting issues
@ -13,7 +13,11 @@ If you suggest a new feature, please give an example of expected behavior and us
If submitting a pull request:
* Please discuss in a issue before submitting a pull request for significant changes.
* Please submit pull requests against the `develop` branch (changes are collected there before making a release).
* 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.
## Local conventions
* Tests: Use `from tests.testcase_with_tmpdir import TestCase` in place of `unittest.TestCase` to get a test object with `self.tmpdir` as temporary location to write to.