Skip to content

docs: explicitly require exactly one changelog type checkbox in copilot instructions #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nilsandrey merged 3 commits into from
Mar 9, 2026
Merged

docs: explicitly require exactly one changelog type checkbox in copilot instructions #12

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f8bc5ce
Initial plan
Copilot Mar 9, 2026
31c8533
Update copilot-instructions.md to require exactly one checkbox and wa…
Copilot Mar 9, 2026
4cfa116
Update pull request description guidelines
nilsandrey Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 (`<!--changelog-description-start-->`, `<!--changelog-description-end-->`, `<!--changelog-type-start-->`, and `<!--changelog-type-end-->`) 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 (`<!--changelog-description-start-->`, `<!--changelog-description-end-->`, `<!--changelog-type-start-->`, and `<!--changelog-type-end-->`) 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.
Copy link

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There’s an extra leading space before “The type of change…” which makes this paragraph misaligned with the surrounding text and can cause odd Markdown rendering in some contexts. Remove the leading whitespace so the paragraph starts flush-left like the others.

Suggested change
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.
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.

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Mar 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sentence says “Exactly one … must be checked” but the workflow logic actually selects the first matching checkbox (Major → Minor → Patch) and only hard-fails when none are checked. To keep the docs strictly accurate, consider wording this as a contributor requirement (“check exactly one”) while also noting what happens if multiple are checked (the workflow will choose the first match).

Suggested change
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.
The type of change must be accurately indicated to ensure proper versioning. Contributors must select **exactly one** of the Major/Minor/Patch checkboxes; if multiple are checked the release workflow will use the first matching checked box in priority order (Major → Minor → Patch) and will fail to create a release only if none are checked.

Copilot uses AI. Check for mistakes.

Sample:

Expand Down