Skip to content

Commit

Permalink
Added a CHANGELOG.md and CONTRIBUTING.md documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jared committed Oct 5, 2024
1 parent a9d2eca commit 03d244f
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 0 deletions.
24 changes: 24 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added

### Changed

### Removed

## v1.0.0

### Added

- Initial versioning release

### Changed

### Removed
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Developer guidelines

## Versioning and changelogging

Packages in this repository must be versioned using [PVP][pvp] for Haskell and
PureScript packages, and [Semantic Versioning 2.0.0][semver] for other languages.

Most importantly, minor and patch changes must not include any breaking changes:
no entity is removed, and there's no change in type definitions and functionality
of preexisting exported entities. If any of this occurs, a major version must be
bumped. Disregarding this rule can end up in breaking client package updates.

Any changes must be logged in `CHANGELOG.md`, which must comply with [Keep A
Changelog](https://keepachangelog.com/en/1.1.0/) requirements. Each entry should
also provide a link to the GitHub issue and/or Pull Request that corresponds to
the entry.

An example entry is below:

```lang-none
* Something is fixed
[#123](https://github.com/mlabs/lambda-buffers/issues/123)
```

## Acknowledgements

This document was adapted from [tx-village
`CONTRIBUTING.md`](https://github.com/mlabs-haskell/tx-village/blob/main/CONTRIBUTING.md)'s.
This is a living document that may change and grow to meet the project's needs

[pvp]: https://pvp.haskell.org/
[semver]: https://semver.org/

0 comments on commit 03d244f

Please sign in to comment.