Add a repo-wide changelog.

Closes #78.
This commit is contained in:
Michael Walker 2017-04-07 20:22:22 +01:00
parent de8ced69a6
commit 0080678a65
2 changed files with 32 additions and 23 deletions

31
CHANGELOG.markdown Normal file
View File

@ -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.

View File

@ -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