Skip to content

docs: document and enforce Conventional Commits for PR titles#52

Closed
wmmc88 wants to merge 1 commit intomicrosoft:mainfrom
wmmc88:contributing-conventional-commits
Closed

docs: document and enforce Conventional Commits for PR titles#52
wmmc88 wants to merge 1 commit intomicrosoft:mainfrom
wmmc88:contributing-conventional-commits

Conversation

@wmmc88
Copy link
Collaborator

@wmmc88 wmmc88 commented Mar 16, 2026

Summary

Updates CONTRIBUTING.md with comprehensive Conventional Commits guidance and adds a GitHub Action to enforce it on PR titles.

Mirror of microsoft/windows-drivers-rs#623 for the samples repo.

Changes

CONTRIBUTING.md

  • Expanded the PR submission section with a dedicated Conventional Commits subsection
  • Documented all valid commit types with descriptions (feat, fix, docs, ci, chore, etc.)
  • Clarified that scope is optional and should be omitted for cross-cutting changes
  • Documented breaking change syntax with examples
  • Fixed stale \master\ branch reference to \main\

.github/workflows/lint-pr-title.yaml

  • Added \�mannn/action-semantic-pull-request@v6\ to validate PR titles
  • Uses \pull_request_target\ trigger (safe for fork-based PRs)
  • Includes sticky PR comment via \marocchino/sticky-pull-request-comment@v2\ for contributor-friendly error messages that auto-delete when resolved

Context

This repo already follows Conventional Commits in practice but it was not explicitly documented or enforced. This PR formalizes the existing convention.

Update CONTRIBUTING.md with comprehensive Conventional Commits guidance including allowed types, optional scopes, breaking change syntax, and examples. Fix stale master reference to main.

Add lint-pr-title.yaml GitHub Action using amannn/action-semantic-pull-request@v6 to enforce the convention on PR titles with sticky PR comments for contributor-friendly error messages.
@wmmc88 wmmc88 closed this Mar 17, 2026
@wmmc88 wmmc88 force-pushed the contributing-conventional-commits branch from 5c7960a to 30fea55 Compare March 17, 2026 21:57
@wmmc88
Copy link
Collaborator Author

wmmc88 commented Mar 17, 2026

superseded by #53

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.

1 participant