From e1e8697191ae5360812a5b981f51441e71170ce7 Mon Sep 17 00:00:00 2001 From: Nils Date: Mon, 9 Mar 2026 09:21:03 -0600 Subject: [PATCH 1/5] Enhance pull request description guidelines Added guidelines for pull request descriptions, including required changelog markup and a template for consistency. Signed-off-by: Nils --- .github/copilot-instructions.md | 49 +++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index cc15e12..0846f27 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -50,3 +50,52 @@ Commands that need user input use `InputModal` or `TwoInputModal` (in `src/modal - **The `perLine()` helper** in `case.ts` applies a function to each line independently. Use it for per-line transforms that don't need cross-line context. - **Multi-selection aware**: All commands must work with multiple simultaneous selections. Use `transformSelections()` or iterate `editor.listSelections()` in reverse. - **Obsidian API is external**: `obsidian`, `electron`, and `@codemirror/*` are externalized by esbuild — never bundle them. +- **Pull request descriptions must use the required changelog markup**: PR descriptions must contain the expected sections for the Release pipeline used to update changelog and release notes. See the follwing "Pull request description content" section. + +### Pull request description content +PR descriptions must contain the expected sections for the Release pipeline used to update changelog and release notes. Take the following template and fill in the description and type of change (major, minor, patch): + +```md +## Description + + + + + + +## Type of Change + + + + +- [ ] **Major** – Breaking change (requires a new major version bump) +- [ ] **Minor** – New feature, backward-compatible (requires a new minor version bump) +- [ ] **Patch** – Bug fix or internal improvement, backward-compatible (requires a new patch version bump) + + +``` + +Sample: + +```md +## Description + + +Fix code quality issues: sentence case, promise handling, deprecated functions, settings headings + + +## Type of Change + + + +- [ ] **Major** – Breaking change (requires a new major version bump) +- [ ] **Minor** – New feature, backward-compatible (requires a new minor version bump) +- [x] **Patch** – Bug fix or internal improvement, backward-compatible (requires a new patch version bump) + + +``` + +Note that the markup comments tags (``, ``, ``, and ``) are required for the pipeline to identify the sections. The description should be concise but informative, as it will be used in the changelog and release notes. The type of change must be accurately indicated to ensure proper versioning. From b06848b17da8792f00ffb09fd37b3d36f85a3784 Mon Sep 17 00:00:00 2001 From: Nils Date: Mon, 9 Mar 2026 09:31:49 -0600 Subject: [PATCH 2/5] Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Nils --- .github/copilot-instructions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 0846f27..a4dde2f 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -50,7 +50,7 @@ Commands that need user input use `InputModal` or `TwoInputModal` (in `src/modal - **The `perLine()` helper** in `case.ts` applies a function to each line independently. Use it for per-line transforms that don't need cross-line context. - **Multi-selection aware**: All commands must work with multiple simultaneous selections. Use `transformSelections()` or iterate `editor.listSelections()` in reverse. - **Obsidian API is external**: `obsidian`, `electron`, and `@codemirror/*` are externalized by esbuild — never bundle them. -- **Pull request descriptions must use the required changelog markup**: PR descriptions must contain the expected sections for the Release pipeline used to update changelog and release notes. See the follwing "Pull request description content" section. +- **Pull request descriptions must use the required changelog markup**: PR descriptions must contain the expected sections for the Release pipeline used to update changelog and release notes. See the following "Pull request description content" section. ### Pull request description content PR descriptions must contain the expected sections for the Release pipeline used to update changelog and release notes. Take the following template and fill in the description and type of change (major, minor, patch): @@ -98,4 +98,4 @@ Fix code quality issues: sentence case, promise handling, deprecated functions, ``` -Note that the markup comments tags (``, ``, ``, and ``) are required for the pipeline to identify the sections. The description should be concise but informative, as it will be used in the changelog and release notes. The type of change must be accurately indicated to ensure proper versioning. +Note that the markup comment tags (``, ``, ``, and ``) are required for the pipeline to identify the sections. The description should be concise but informative, as it will be used in the changelog and release notes. The type of change must be accurately indicated to ensure proper versioning. From b232f0a0a8b0a7dcb14f9663530738eb54a12a53 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Mon, 9 Mar 2026 09:35:57 -0600 Subject: [PATCH 3/5] Remove trailing whitespace from copilot-instructions.md (#11) --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: nilsandrey <3579285+nilsandrey@users.noreply.github.com> --- .github/copilot-instructions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index a4dde2f..86c3517 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -52,7 +52,7 @@ Commands that need user input use `InputModal` or `TwoInputModal` (in `src/modal - **Obsidian API is external**: `obsidian`, `electron`, and `@codemirror/*` are externalized by esbuild — never bundle them. - **Pull request descriptions must use the required changelog markup**: PR descriptions must contain the expected sections for the Release pipeline used to update changelog and release notes. See the following "Pull request description content" section. -### Pull request description content +### Pull request description content PR descriptions must contain the expected sections for the Release pipeline used to update changelog and release notes. Take the following template and fill in the description and type of change (major, minor, patch): ```md @@ -63,7 +63,7 @@ PR descriptions must contain the expected sections for the Release pipeline used This text is used by the automated changelog pipeline — be clear and complete. Example: "Add 'Reverse words on each line' transform command." --> - + ## Type of Change From 23b4a54614c52dd5728bcce0f444440a2e5e7bce Mon Sep 17 00:00:00 2001 From: Nils Date: Mon, 9 Mar 2026 09:38:55 -0600 Subject: [PATCH 4/5] Revise PR description content and markup requirements Updated PR description guidelines to include a reference to the PULL_REQUEST_TEMPLATE.md and emphasized the importance of markup comment tags for changelog processing. Signed-off-by: Nils --- .github/copilot-instructions.md | 27 +-------------------------- 1 file changed, 1 insertion(+), 26 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 86c3517..db11adb 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -53,30 +53,7 @@ Commands that need user input use `InputModal` or `TwoInputModal` (in `src/modal - **Pull request descriptions must use the required changelog markup**: PR descriptions must contain the expected sections for the Release pipeline used to update changelog and release notes. See the following "Pull request description content" section. ### Pull request description content -PR descriptions must contain the expected sections for the Release pipeline used to update changelog and release notes. Take the following template and fill in the description and type of change (major, minor, patch): - -```md -## Description - - - - - - -## Type of Change - - - - -- [ ] **Major** – Breaking change (requires a new major version bump) -- [ ] **Minor** – New feature, backward-compatible (requires a new minor version bump) -- [ ] **Patch** – Bug fix or internal improvement, backward-compatible (requires a new patch version bump) - - -``` +PR descriptions must contain the expected sections for the Release pipeline used to update the changelog and release notes. Follow the [PULL_REQUEST_TEMPLATE.md](./PULL_REQUEST_TEMPLATE.md) template and fill in the description and type of change (major, minor, patch). Note that the markup comment tags (``, ``, ``, and ``) are required for the pipeline to identify the sections. The description should be concise but informative, as it will be used in the changelog and release notes. The type of change must be accurately indicated to ensure proper versioning. Sample: @@ -97,5 +74,3 @@ Fix code quality issues: sentence case, promise handling, deprecated functions, ``` - -Note that the markup comment tags (``, ``, ``, and ``) are required for the pipeline to identify the sections. The description should be concise but informative, as it will be used in the changelog and release notes. The type of change must be accurately indicated to ensure proper versioning. From c7f68ca3bef33e2d1143f74c370fcf5c4fde4c05 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Mon, 9 Mar 2026 09:53:20 -0600 Subject: [PATCH 5/5] docs: explicitly require exactly one changelog type checkbox in copilot instructions (#12) --------- Signed-off-by: Nils Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: nilsandrey <3579285+nilsandrey@users.noreply.github.com> Co-authored-by: Nils --- .github/copilot-instructions.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index db11adb..0fb85c0 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -53,7 +53,10 @@ Commands that need user input use `InputModal` or `TwoInputModal` (in `src/modal - **Pull request descriptions must use the required changelog markup**: PR descriptions must contain the expected sections for the Release pipeline used to update changelog and release notes. See the following "Pull request description content" section. ### Pull request description content -PR descriptions must contain the expected sections for the Release pipeline used to update the changelog and release notes. Follow the [PULL_REQUEST_TEMPLATE.md](./PULL_REQUEST_TEMPLATE.md) template and fill in the description and type of change (major, minor, patch). Note that the markup comment tags (``, ``, ``, and ``) are required for the pipeline to identify the sections. The description should be concise but informative, as it will be used in the changelog and release notes. The type of change must be accurately indicated to ensure proper versioning. + +PR descriptions must contain the expected sections for the Release pipeline used to update the changelog and release notes. Follow the [PULL_REQUEST_TEMPLATE.md](./PULL_REQUEST_TEMPLATE.md) template and fill in the description and type of change (major, minor, patch). Note that the markup comment tags (``, ``, ``, and ``) are required for the pipeline to identify the sections. The description should be concise but informative, as it will be used in the changelog and release notes. + + The type of change must be accurately indicated to ensure proper versioning. **Exactly one** of the Major/Minor/Patch checkboxes must be checked — the release workflow picks the first matching checked box (Major → Minor → Patch) and will fail to create a release if none are checked. Sample: