Skip to content

SYS-8736 open-source exempt from Jira validation, added regression te… - #45

Open
mmaharjan-ccdc wants to merge 3 commits into
mainfrom
SYS-8736-break-tag
Open

mmaharjan-ccdc wants to merge 3 commits into
mainfrom
SYS-8736-break-tag

Conversation

@mmaharjan-ccdc

Copy link
Copy Markdown
Contributor

…sts for Opensource, and unsupported types

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

README documentation does not yet match the validator’s Jira exemption and accepted commit forms.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Updates commit validation so open-source repositories skip Jira checks while still enforcing opted-in Conventional Commits rules.

Changes:

  • Narrows the open-source Jira exemption.
  • Adds regression tests for open-source and unsupported commit types.
  • Documents Conventional Commits configuration and supported types.
File summaries
File Summary
README.md Adds Conventional Commits documentation.
main/githooks.py Adjusts Jira validation and adds regression tests.
Review details

Suppressed comments (2)

README.md:35

  • The documented supported-type list does not match the validator: conventional_commit_present also accepts a BREAKING CHANGE: ... header via its regex, even though this list omits it and break is described as the major-version marker. Either reject that header or document it explicitly; otherwise the README and the unsupported-type regression do not describe the actual enforcement.
Supported types are `break`, `feat`, `fix`, `refactor`, `build`, `chore`, `ci`,
`docs`, `perf`, `revert`, `style`, and `test`. CCDC release configurations use
`break` for a major version. A branch may contain more than one type.
Releases should choose the highest required version bump,
so `break` takes precedence over `feat`, which takes precedence over `fix`.

README.md:25

  • This new section does not document the new ccdc-opensource/* Jira exemption, while the overview immediately above still says commits without a Jira ID are flagged. Update the Jira description and add the exception so open-source contributors are not given inaccurate validation requirements.
Conventional Commits validation is optional. Add a `.conventional-commits` file
at the repository root to enable it. The supported header format is:
  • Files reviewed: 2/2 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants