Skip to content

Commit

Permalink
Merge pull request #757 from andrewcbennett/changelog_documentation
Browse files Browse the repository at this point in the history
Changelog documentation
  • Loading branch information
pganssle committed Jun 21, 2018
2 parents 97dd369 + 05c928b commit c250e24
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 1 deletion.
1 change: 1 addition & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ switch, and thus all their contributions are dual-licensed.
- Alex Verdyan <verdyan@MASKED>
- Alex Willmer <alex@moreati.org.uk> (gh: @moreati) **R**
- Alexander Brugh <alexander.brugh@MASKED> (gh: @abrugh)
- Andrew Bennett (gh: @andrewcbennett) **D**
- Andrew Murray <radarhere@MASKED>
- Bernat Gabor <bgabor8@bloomberg.net> (gh: @gaborbernat) **D**
- Brandon W Maister <quodlibetor@MASKED>
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions changelog.d/757.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Improved the contributing documentation to specify where to create changelog files. Contributed by @andrewcbennett (gh pr #757)

0 comments on commit c250e24

Please sign in to comment.