From 7a58084df9867505425a30f48d089cf02ba1c127 Mon Sep 17 00:00:00 2001 From: Nora Date: Fri, 14 Jun 2024 14:50:18 +0000 Subject: [PATCH 1/3] Remove checklist but keep a note on the changelog --- .github/pull_request_template.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) 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! From cd70b19bb39c507d9d931b860ce7e052cf196532 Mon Sep 17 00:00:00 2001 From: Nora Date: Fri, 14 Jun 2024 14:52:58 +0000 Subject: [PATCH 2/3] Add changelog reminder to PR submit guidance --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d583b0870..a2d9a0dae 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 doing user-facing changes. ## Setting up a local build From 15fa23acb4f6d7d60cecebeed86e823049f8ece5 Mon Sep 17 00:00:00 2001 From: Nora Date: Mon, 17 Jun 2024 09:22:27 +0200 Subject: [PATCH 3/3] Fix grammatical issue Co-authored-by: Charis Kyriakou --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a2d9a0dae..715aa1a5f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,7 +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 doing user-facing changes. +- 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