diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 4841aec..c93c241 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +1,5 @@ --- - [ ] I have reviewed CONTRIBUTING.md. - [ ] My commits and title use the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) format. -- [ ] I have documented any breaking changes according to [SemVer](https://semver.org/). +- [ ] I have documented changes and additions in the CHANGELOG.md. --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f841d98..0bf5a37 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,8 +29,9 @@ For any code contributions (Lua and/or Go), you should follow these rules: 1. Ensure that any new install or build dependencies are documented in the README.md and pull request. -2. Mention any and all changes, this includes useful file locations and -breaking changes. +2. Mention any and all changes, feature additons, removals, etc. This includes +useful file locations and breaking changes. Document them in the [changelog](CHANGELOG.md) +in the pull request. 3. We use [Semver](http://semver.org/) for versioning and [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)