diff options
| author | Paul Ganssle <paul@ganssle.io> | 2017-12-05 15:34:42 +0000 |
|---|---|---|
| committer | Paul Ganssle <paul@ganssle.io> | 2017-12-05 15:34:42 +0000 |
| commit | d56a9c5c3c8c14916dee74f9d0aade0c4addecdc (patch) | |
| tree | 077e07c5386d6ebec0dda528141d32b03be5153c /CONTRIBUTING.md | |
| parent | 4f9431048d98bf1dc75b2afc12279adb75582b7f (diff) | |
| download | dateutil-d56a9c5c3c8c14916dee74f9d0aade0c4addecdc.tar.gz | |
Improve CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eb618c0..755379c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,11 +18,11 @@ While pull requests fixing bugs are accepted, they are *not* required - the bug ### Feature requests -If you would like to see a new feature in `dateutil`, it is probably best to start an issue for discussion. You are welcome to prepare a pull request to start, but if it's going to be a lot of work, it's probably best to start by opening an issue so that you can know. +If you would like to see a new feature in `dateutil`, it is probably best to start an issue for discussion rather than taking the time to implement a feature which may or may not be appropriate for `dateutil`'s API. For minor features (ones where you don't have to put a lot of effort into the PR), a pull request is fine but still not necessary. ### Pull requests -If you would like to fix something in `dateutil` - improvements to documentation, bug fixes, feature implementations, fixes to the build system, etc - pull requests are welcome! Try to keep your coding to [PEP 8 style](https://www.python.org/dev/peps/pep-0008/), with the minor modification that the existing `dateutil` class naming style does not use the CapWords convention. +If you would like to fix something in `dateutil` - improvements to documentation, bug fixes, feature implementations, fixes to the build system, etc - pull requests are welcome! Where possible, try to keep your coding to [PEP 8 style](https://www.python.org/dev/peps/pep-0008/), with the minor modification that the existing `dateutil` class naming style does not use the CapWords convention, or where the existing style does not follow PEP 8. The most important thing to include in your pull request are *tests* - please write one or more tests to cover the behavior you intend your patch to improve. Ideally, tests would use only the public interface - try to get 100% difference coverage using only supported behavior of the API. |