diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b07c02ef..f463bf9a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -91,9 +91,10 @@ If any change has been made to the `config.rs` file, it should also be documente Changes compared to the latest Alacritty release which have a direct effect on the user (opposed to things like code refactorings or documentation/tests) additionally need to be documented in the -`CHANGELOG.md`. The existing entries should be used as a style guideline. The change log should be -used to document changes from a user-perspective, instead of explaining the technical background -(like commit messages). More information about Alacritty's change log format can be found +`CHANGELOG.md`. When notable change is made to `alacritty_terminal` it should be documnted in its +`CHANGELOG.md` as well. The existing entries should be used as a style guideline. The change log +should be used to document changes from a user-perspective, instead of explaining the technical +background (like commit messages). More information about Alacritty's change log format can be found [here](https://keepachangelog.com). ### Style |