docs: update contributing info to include writing changes to changelog

Rosettea · May 30, 2022 · 3f745e7 · 3f745e7
1 parent f9a2a98
commit 3f745e7
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git 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
@@ -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/)