diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3a059d1dd..9450a9529 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,8 +5,4 @@ Replace this with a description of the changes your pull request makes. -## Checklist - -- [ ] [CHANGELOG.md](https://github.com/github/vscode-codeql/blob/main/extensions/ql-vscode/CHANGELOG.md) has been updated to incorporate all user visible changes made by this pull request. -- [ ] Issues have been created for any UI or other user-facing changes made by this pull request. -- [ ] _[Maintainers only]_ If this pull request makes user-facing changes that require documentation changes, open a corresponding docs pull request in the [github/codeql](https://github.com/github/codeql/tree/main/docs/codeql/codeql-for-visual-studio-code) repo and add the `ready-for-doc-review` label there. +Remember to update the [changelog](https://github.com/github/vscode-codeql/blob/main/extensions/ql-vscode/CHANGELOG.md) if there have been user-facing changes! diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d583b0870..715aa1a5f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,6 +28,7 @@ Here are a few things you can do that will increase the likelihood of your pull - [Integration tests that do require the VS Code API are located here](extensions/ql-vscode/src/vscode-tests). - Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests. - Write a [good commit message](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). +- Update the [changelog](https://github.com/github/vscode-codeql/blob/main/extensions/ql-vscode/CHANGELOG.md) if you are making user-facing changes. ## Setting up a local build