sammyette
/
Hilbish
mirror of https://github.com/Hilbis/Hilbish
2
2
Fork 0
Code Issues Releases Wiki Activity

docs: update contributing info to include writing changes to changelog

lazy-interfaces
TorchedSammy 2022-05-30 18:16:36 -04:00
parent f9a2a981b4
commit 3f745e7e4d
Signed by: sammyette
GPG Key ID: 904FC49417B44DCD
2 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/pull_request_template.md vendored
View File

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

5
CONTRIBUTING.md
View File

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