diff options
| author | Andrew Bennett <andrewcbennett@users.noreply.github.com> | 2018-06-08 16:00:59 +0100 |
|---|---|---|
| committer | Paul Ganssle <paul@ganssle.io> | 2018-06-21 09:41:45 -0400 |
| commit | a2dcae0fc26b408131e7a3dbdf23fc3789ee746e (patch) | |
| tree | 32cecfcfdf1d22027f1fcd4ae503eb77a70272cc /CONTRIBUTING.md | |
| parent | 97dd3697df28bc50baaa2a098124a7428218f74e (diff) | |
| download | dateutil-a2dcae0fc26b408131e7a3dbdf23fc3789ee746e.tar.gz | |
Specifies directory for changelog entries
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 28b18b1..e93dab2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,7 +28,7 @@ If you would like to fix something in `dateutil` - improvements to documentatio 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. #### Changelog -To keep users abreast of the changes to the module and to give proper credit, `dateutil` maintains a changelog, which is managed by [towncrier](https://github.com/hawkowl/towncrier). To add a changelog entry, make a new file called `<issue_no>.<type>.rst`, where `<issue_no>` is the number of the PR you've just made (it's easiest to add the changelog *after* you've created the PR so you'll have this number), and `<type>` is one of the following types: +To keep users abreast of the changes to the module and to give proper credit, `dateutil` maintains a changelog, which is managed by [towncrier](https://github.com/hawkowl/towncrier). To add a changelog entry, make a new file called `<issue_no>.<type>.rst` in the `changelog.d` directory, where `<issue_no>` is the number of the PR you've just made (it's easiest to add the changelog *after* you've created the PR so you'll have this number), and `<type>` is one of the following types: - `feature`: A new feature, (e.g. a new function, method, attribute, etc) - `bugfix`: A fix to a bug |