Skip to content

docs: Add Conventional Commits guidelines for PR titles#8

Merged
franky47 merged 3 commits into
nextfrom
copilot/update-copilot-guidelines-conventions
Sep 9, 2025
Merged

docs: Add Conventional Commits guidelines for PR titles#8
franky47 merged 3 commits into
nextfrom
copilot/update-copilot-guidelines-conventions

Conversation

Copilot AI commented Sep 9, 2025

Copy link
Copy Markdown
Contributor

This PR adds comprehensive Conventional Commits guidelines to the Copilot instructions to support future semantic-release automation for version management.

Changes

Added a new "Contributing Guidelines" section to .github/copilot-instructions.md that includes:

  • Required format: <type>: <description> for all PR titles
  • Complete type reference: feat, fix, docs, style, refactor, test, chore with clear descriptions
  • Practical examples of properly formatted PR titles
  • Breaking changes syntax using BREAKING CHANGE: in the commit body (following conventional commits best practices)
  • Benefits explanation: automatic version bumping, changelog generation, and release notes

Examples of compliant PR titles

feat: Add TypeScript 5.6 support
fix: Handle malformed package.json files
docs: Update CLI usage examples
chore: Update dependencies to latest versions

Breaking changes format

fix: Some bad bug that requires a major version

BREAKING CHANGE: this breaks everything. Sorry.

This standardization will enable automatic semantic versioning when semantic-release is fully integrated, ensuring consistent version management based on the type and scope of changes in each PR.

Fixes #7.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: franky47 <1174092+franky47@users.noreply.github.com>
Copilot AI changed the title [WIP] Follow conventional commits docs: Add Conventional Commits guidelines for PR titles Sep 9, 2025
Copilot AI requested a review from franky47 September 9, 2025 14:43

@franky47 franky47 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@copilot the breaking changes part needs clarification (I don't think exclamation points are part of the ConvCo spec? If they are, TIL).

Comment thread .github/copilot-instructions.md Outdated
Co-authored-by: franky47 <1174092+franky47@users.noreply.github.com>

Copilot AI commented Sep 9, 2025

Copy link
Copy Markdown
Contributor Author

@copilot the breaking changes part needs clarification (I don't think exclamation points are part of the ConvCo spec? If they are, TIL).

You're absolutely right! The exclamation point syntax (!) is part of the Conventional Commits spec, but the more traditional and widely supported approach is using BREAKING CHANGE: in the commit body. I've updated the documentation to use the correct format as you demonstrated. Fixed in f115aa1.

@franky47 franky47 marked this pull request as ready for review September 9, 2025 17:17
@franky47 franky47 merged commit 01ecb76 into next Sep 9, 2025
2 checks passed
@franky47 franky47 deleted the copilot/update-copilot-guidelines-conventions branch September 9, 2025 17:17
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.

Follow conventional commits

2 participants