Skip to content

Enhance pull request description guidelines and Release next version#10

Merged
nilsandrey merged 5 commits intomainfrom
nilsandrey-release-patch
Mar 9, 2026
Merged

Enhance pull request description guidelines and Release next version#10
nilsandrey merged 5 commits intomainfrom
nilsandrey-release-patch

Conversation

@nilsandrey
Copy link
Copy Markdown
Owner

Added guidelines for pull request descriptions, including required changelog markup and a template for consistency and remember it on every PR. Using this PR to release the latest merged one, where I forgot to include these release instructions #9.

Description

Fix code quality issues: sentence case, promise handling, deprecated functions, and settings headings.

Related Issues

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)

Checklist

  • I have read CONTRIBUTING.md
  • The build passes locally (npm run build)
  • All tests pass locally (npm test)
  • New or modified transforms have unit tests
  • The README.md Features table is updated (if a new command was added)
  • CHANGELOG.md entry is not required here — the pipeline generates it automatically
  • I have tested the change manually inside Obsidian

Screenshots / Recordings

Added guidelines for pull request descriptions, including required changelog markup and a template for consistency.

Signed-off-by: Nils <nilsandrey@gmail.com>
Copilot AI review requested due to automatic review settings March 9, 2026 15:25
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the repository’s contributor/Copilot guidance to require specific PR description markup so the existing Release workflow can reliably extract the changelog description and version bump type.

Changes:

  • Documented required PR-body changelog markers (<!--changelog-*-start/end-->) in .github/copilot-instructions.md.
  • Added an embedded PR description template and a filled example to encourage consistent PR descriptions.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Nils <nilsandrey@gmail.com>
Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 9, 2026

@nilsandrey I've opened a new pull request, #11, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot AI and others added 2 commits March 9, 2026 09:35
---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: nilsandrey <3579285+nilsandrey@users.noreply.github.com>
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 <nilsandrey@gmail.com>
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 9, 2026

@nilsandrey I've opened a new pull request, #12, to work on those changes. Once the pull request is ready, I'll request review from you.

…ot instructions (#12)

---------

Signed-off-by: Nils <nilsandrey@gmail.com>
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 <nilsandrey@gmail.com>
@nilsandrey nilsandrey merged commit df68d70 into main Mar 9, 2026
@nilsandrey nilsandrey deleted the nilsandrey-release-patch branch March 9, 2026 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Issues detected in code quality

3 participants