From 0cc1109c05c1871b225a033836b6e87e4378a5e4 Mon Sep 17 00:00:00 2001 From: Oleg Grenrus Date: Mon, 30 Sep 2019 19:40:18 +0300 Subject: [PATCH] Add changelog.d directory, amend CONTRIBUTING.md --- CONTRIBUTING.md | 29 ++++++++++++++++++++++++++++- changelog.d/issue1028 | 10 ++++++++++ changelog.d/issue1200 | 10 ++++++++++ changelog.d/todo | 6 ++++++ 4 files changed, 54 insertions(+), 1 deletion(-) create mode 100644 changelog.d/issue1028 create mode 100644 changelog.d/issue1200 create mode 100644 changelog.d/todo diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 82e66a5d..46eb65f7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,7 +35,34 @@ Some things we like: Though we aren't sticklers for style, the `.stylish-haskell.yaml` and `HLint.hs` files in the repository provide a good baseline for consistency. -**Important**: please do not modify the changelog files nor the versions of the servant packages you are sending patches for. We take care of this before every release and do it uniformly for all the servant packages, so there's no need to worry about this for your pull requests. +**Important**: please do not modify the versions of the servant packages you are sending patches for. + +## Changelog entries + +We experiment with using [changelog-d tool](https://github.com/phadej/changelog-d) to assemble changelogs. +You are not required to install it. + +In each PR please add a file to `changelog.d` directory named after issue you are solving or the pull request itself (in a separate commit after you know the pull request number). For example + +```cabal +synopsis: One sentence summary of the change. +prs: #1219 +issues: #1028 + +description: { + +A longer description. Small changes don't need this. +Bigger ones definitely do, for example we try to include migration hints +for breaking changes. + +However if you don't know what to write, that's ok too. + +By the way, the braces around are omitted when the file is parsed. +They can be used so the field doesn't need to be indented, which is handy +for prose. + +} +``` ## PR process diff --git a/changelog.d/issue1028 b/changelog.d/issue1028 new file mode 100644 index 00000000..aaa51e50 --- /dev/null +++ b/changelog.d/issue1028 @@ -0,0 +1,10 @@ +synopsis: Add NoContentVerb +prs: #1228 #1219 +issues: #1028 +significance: significant + +description: { + +TBW + +} diff --git a/changelog.d/issue1200 b/changelog.d/issue1200 new file mode 100644 index 00000000..ad664066 --- /dev/null +++ b/changelog.d/issue1200 @@ -0,0 +1,10 @@ +synopsis: Fix Verb with headers checking content type differently +prs: #1204 +issues: #1200 +packages: servant-client servant-client-core servant-http-streams + +description: { + +TBW + +} diff --git a/changelog.d/todo b/changelog.d/todo new file mode 100644 index 00000000..7ee059f6 --- /dev/null +++ b/changelog.d/todo @@ -0,0 +1,6 @@ +synopsis: unclassified pull requests +prs: #1229 #1224 #1226 #1216 #1214 #1194 +prs: #1194 #1201 #1198 #1197 #1190 #1188 +prs: #1183 #1181 #1182 #1175 #1175 #1174 +prs: #1173 #1171 #1154 #1162 #1157 #1159 +prs: #1156