Skip to content

docs: enforce space between type and scope in commit convention #7

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

Jump to bottom
Merged
warengonzaga merged 2 commits into from
Jan 13, 2026
Merged

docs: enforce space between type and scope in commit convention #7

warengonzaga merged 2 commits into from
Jan 13, 2026

Conversation

Copy link
Contributor

Copilot AI commented Jan 13, 2026 •
edited
Loading

Changes commit format from type(scope): to type (scope): for improved visual separation and readability.

Before:

📦 new(api): endpoint for user registration
🔧 update(ui): enhance button animations
🔒 security(auth): fix JWT token validation

After:

📦 new (api): endpoint for user registration
🔧 update (ui): enhance button animations
🔒 security (auth): fix JWT token validation

Changes

  • Format specification: Updated from <emoji> <type>(<scope>): to <emoji> <type> (<scope>): across all documentation
  • Examples: Updated 100+ commit examples in README.md, SPECIFICATION.md, and QUICK-REFERENCE.md
  • Tooling: Updated GitHub Copilot configuration strings in README.md and CONTRIBUTING.md
  • Templates: Updated examples/AGENTS.md and examples/copilot.instructions.md
  • Validation: Added "missing space before scope" to bad examples section in SPECIFICATION.md

Files Modified

  • README.md (main docs + 30+ examples)
  • SPECIFICATION.md (format rules + all type definitions)
  • QUICK-REFERENCE.md (cheatsheet + common patterns)
  • CONTRIBUTING.md (contributor examples + Copilot config)
  • examples/AGENTS.md (AI agent template)
  • examples/copilot.instructions.md (Copilot instructions)
Original prompt

This section details on the original issue you should resolve

<issue_title>Change commit convention: enforce a space between context and scope</issue_title>
<issue_description>## Problem Statement
Currently, the commit convention uses no space between the context and the scope (e.g., new(core):). This format is less readable and visually pleasing.

Proposed Change

Update the commit convention to include a space between the context and scope, so it becomes new (core): instead of new(core):. This change applies to all relevant commit types and scopes defined in the project.

Rationale

  • Improves readability for contributors.
  • Aligns with common style conventions.
  • Makes context and scope easier to distinguish at a glance.

Impact

This will require updating the documentation and possibly tooling/automation/scripts that enforce or recognize the current convention.</issue_description>

Comments on the Issue (you are @copilot in this section)

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@warengonzaga
docs: update commit convention with space between type and scope
5eb8e81 
Co-authored-by: warengonzaga <15052701+warengonzaga@users.noreply.github.com>
Copilot AI changed the title [WIP] Update commit convention to enforce space between context and scope docs: enforce space between type and scope in commit convention Jan 13, 2026
Copilot AI requested a review from warengonzaga January 13, 2026 08:29
@warengonzaga warengonzaga marked this pull request as ready for review January 13, 2026 08:34
@warengonzaga warengonzaga merged commit 8c22262 into main Jan 13, 2026
1 check passed
@warengonzaga warengonzaga deleted the copilot/update-commit-convention branch January 13, 2026 08:36
warengonzaga pushed a commit that referenced this pull request Jan 13, 2026
📖 docs: enforce space between type and scope in commit convention (#7)
a0207ba 
* Initial plan

* docs: update commit convention with space between type and scope

Co-authored-by: warengonzaga <15052701+warengonzaga@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@warengonzaga warengonzaga Awaiting requested review from warengonzaga

Assignees

@warengonzaga warengonzaga

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Change commit convention: enforce a space between context and scope

2 participants

@warengonzaga