From 0080678a659e3b33b15f3bee02f0fcc78896bb1b Mon Sep 17 00:00:00 2001 From: Michael Walker Date: Fri, 7 Apr 2017 20:22:22 +0100 Subject: [PATCH] Add a repo-wide changelog. Closes #78. --- CHANGELOG.markdown | 31 +++++++++++++++++++++++++++++++ README.markdown | 24 +----------------------- 2 files changed, 32 insertions(+), 23 deletions(-) create mode 100644 CHANGELOG.markdown diff --git a/CHANGELOG.markdown b/CHANGELOG.markdown new file mode 100644 index 0000000..166afb8 --- /dev/null +++ b/CHANGELOG.markdown @@ -0,0 +1,31 @@ +Change Log +========== + +All notable changes to projects in this repository will be documented +in the change logs. Furthermore, these projects are versioned +according to the [Package Versioning Policy][pvp], the *de facto* +standard Haskell versioning scheme. + +[pvp]: https://pvp.haskell.org + +Each package has its own change log: + +- [concurrency/CHANGELOG.markdown][concurrency] +- [dejafu/CHANGELOG.markdown][dejafu] +- [hunit-dejafu/CHANGELOG.markdown][hunit-dejafu] +- [tasty-dejafu/CHANGELOG.markdown][tasty-dejafu] + +[concurrency]: https://github.com/barrucadu/dejafu/blob/master/concurrency/CHANGELOG.markdown +[dejafu]: https://github.com/barrucadu/dejafu/blob/master/dejafu/CHANGELOG.markdown +[hunit-dejafu]: https://github.com/barrucadu/dejafu/blob/master/hunit-dejafu/CHANGELOG.markdown +[tasty-dejafu]: https://github.com/barrucadu/dejafu/blob/master/tasty-dejafu/CHANGELOG.markdown + +Changes to purely internal APIs are not included. Changes to internal +APIs which are exposed through non-internal modules are detailed as if +the change were made in the exposing module (eg, visible additions to +Test.DejaFu.STM.Internal, such as a new typeclass instance, will show +up as if they were added to Test.DejaFu.STM). + +Additions may be breaking changes as far as the PVP is concerned. For +example, the addition of new data constructors, or new typeclass +member functions. diff --git a/README.markdown b/README.markdown index 166271d..35911e8 100644 --- a/README.markdown +++ b/README.markdown @@ -397,29 +397,7 @@ time. Release Notes / Change Logs --------------------------- -All notable changes to projects in this repository will be documented -in the change logs. Furthermore, these projects are versioned -according to the [Package Versioning Policy][pvp], the *de facto* -standard Haskell versioning scheme. - -Each package has its own change log: - -- [concurrency/CHANGELOG.markdown](https://github.com/barrucadu/dejafu/blob/master/concurrency/CHANGELOG.markdown) -- [dejafu/CHANGELOG.markdown](https://github.com/barrucadu/dejafu/blob/master/dejafu/CHANGELOG.markdown) -- [hunit-dejafu/CHANGELOG.markdown](https://github.com/barrucadu/dejafu/blob/master/hunit-dejafu/CHANGELOG.markdown) -- [tasty-dejafu/CHANGELOG.markdown](https://github.com/barrucadu/dejafu/blob/master/tasty-dejafu/CHANGELOG.markdown) - -Changes to purely internal APIs are not included. Changes to internal -APIs which are exposed through non-internal modules are detailed as if -the change were made in the exposing module (eg, visible additions to -Test.DejaFu.STM.Internal, such as a new typeclass instance, will show -up as if they were added to Test.DejaFu.STM). - -Additions may be breaking changes as far as the PVP is concerned. For -example, the addition of new data constructors, or new typeclass -member functions. - -[pvp]: https://pvp.haskell.org/ +See the CHANGELOG.markdown file. Bibliography