Skip to content

Commit

Permalink
Add note about updating CHANGELOG
Browse files Browse the repository at this point in the history
Add a section about updating the CHANGELOG.md with information about changes when submitting a PR.
  • Loading branch information
rurounijones authored Oct 18, 2023
1 parent 88d75b4 commit 41b6342
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,11 @@ like so:
Resolves: #123
```

## Don't forget to update the `CHANGELOG.md`

Don't forget to update the `CHANGELOG.md` file with your change in the
`Unreleased` section

## Squash commits and rebase before merging

When you are ready to merge then squash your commits so that they form a
Expand All @@ -90,4 +95,4 @@ This project makes use of the following tools to lint the lua and .proto files

It is not mandatory to run these yourself on your local machine however they
are run as part of the automated checks when you create a pull request so it
may save you time to run them yourself before-hand.
may save you time to run them yourself before-hand.

0 comments on commit 41b6342

Please sign in to comment.