-
Notifications
You must be signed in to change notification settings - Fork 16
Add Watchflow governance rules (3 rules, 1 high-priority) #44
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.
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
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,25 @@ | ||
| rules: | ||
| # Essential Open Source Rules | ||
| - description: "Pull requests must have descriptive titles following conventional commit format" | ||
| enabled: true | ||
| severity: "medium" | ||
| event_types: ["pull_request"] | ||
| parameters: | ||
| title_pattern: "^feat|^fix|^docs|^style|^refactor|^test|^chore|^perf|^ci|^build|^revert" | ||
|
|
||
| - description: "New contributors require approval from at least one past contributor" | ||
| enabled: true | ||
| severity: "medium" | ||
| event_types: ["pull_request"] | ||
| parameters: | ||
| min_past_contributors: 1 | ||
|
|
||
| - description: "Code changes must include corresponding tests" | ||
| enabled: true | ||
| severity: "medium" | ||
| event_types: ["pull_request"] | ||
| parameters: | ||
| pattern: "tests/.*\\.py$|test_.*\\.py$" | ||
| condition_type: "files_match_pattern" | ||
|
|
||
| - description: "Changes to critical files require review from code owners" | ||
| enabled: true | ||
| severity: "high" | ||
| event_types: ["pull_request"] | ||
|
|
||
| - description: "No direct pushes to main branch - all changes must go through PRs" | ||
| enabled: true | ||
| severity: "critical" | ||
| event_types: ["push"] | ||
| parameters: | ||
| allow_force_push: false | ||
| - key: require_linked_issue | ||
| name: Require Linked Issue | ||
| description: Block PRs without issue references to ensure traceability and context | ||
| for changes. | ||
| severity: high | ||
| category: quality | ||
| reasoning: The repository has an 85% unlinked issue rate, indicating most PRs lack | ||
| issue references which risks poor traceability and drive-by contributions. | ||
| - key: required_workflows | ||
| name: Require CI Workflow Pass | ||
| description: Ensure all PRs pass CI workflows before merging to maintain code quality | ||
| and prevent regressions. | ||
| severity: medium | ||
| category: quality | ||
| reasoning: The repository has established CI/CD workflows, so enforcing passing | ||
| CI before merge helps maintain quality and governance. | ||
| - key: title_pattern | ||
| name: Enforce Conventional Commit Titles | ||
| description: Require PR titles to follow Conventional Commit patterns (feat:, fix:, | ||
| etc.) for better changelog generation and clarity. | ||
| severity: medium | ||
| category: quality | ||
| reasoning: No explicit mention of commit message standards; enforcing title patterns | ||
| improves commit hygiene and project governance. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🌐 Web query:
Watchflow title_pattern rule pattern field required documentation💡 Result:
In Watchflow,
title_patternis a rule parameter (a string) used to enforce a pull request title format via a regular expression in your repository’s.watchflow/rules.yamlfile. Example:parameters.title_pattern: "^[A-Z]+-[0-9]+: .+". [1]It’s not a standalone “pattern” field at the top level—Watchflow rules are defined under
rules:and commonly include fields likedescription,severity,event_types, and aparameters:map where rule-specific inputs (liketitle_pattern) live. [2]If you’re using a “PR title must match …” rule, then
title_patternis effectively required for that rule to work, because it defines what the title must match. [1]Sources: [1] [2]
Add
parameters:section with regex pattern to enforce Conventional Commit titles.The rule lacks the required
title_patternparameter. In Watchflow,title_patternmust be defined within aparameters:map as a regex string. Without it, the rule cannot validate PR titles. Update the rule to:🤖 Prompt for AI Agents