docs: contributing and issue/PR templates#3
Conversation
📝 WalkthroughWalkthroughAdds five community health files: ChangesCommunity Health Files
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/ISSUE_TEMPLATE/bec_proposal.md:
- Around line 8-17: The proposal template sections are mismatched with the BEC
bundle contract: it asks for Language(s) instead of the fields the bundle
actually persists. Update the bec_proposal template to collect the
bundle-aligned metadata using the existing Intent/Why it matters/Check/Severity
structure, and replace the Language(s) prompt with the contract-backed fields
such as paths, severity, and optionally rejected_alternatives so proposals can
map cleanly into catalog entries.
In @.github/ISSUE_TEMPLATE/bug_report.md:
- Around line 23-24: The bug report template is pointing reporters to the wrong
BEC reference, so update the “Rule / check involved” prompt in the bug_report
template to mention the actual bundle path used by the repo’s BEC format or the
check command instead of `.bec/rules.yaml`. Keep the wording aligned with the
existing template section and use the relevant prompt text in the bug report
markdown to guide reporters to `becs/<id>.bec.yaml` or the command they should
run.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 13951ee2-8c02-4f2d-84ae-671994ca4717
📒 Files selected for processing (5)
.github/ISSUE_TEMPLATE/bec_proposal.md.github/ISSUE_TEMPLATE/bug_report.md.github/ISSUE_TEMPLATE/feature_request.md.github/pull_request_template.mdCONTRIBUTING.md
| **Intent** — what should this rule enforce? | ||
|
|
||
| **Why it matters** — what breaks if it is violated? | ||
|
|
||
| **Check** — how would it be detected? (a `forbid` regex, a built-in check, or a | ||
| custom script) | ||
|
|
||
| **Language(s)** — Python, JS/TS, any, ... | ||
|
|
||
| **Severity** — `blocking` or `warning`, and why. |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win
Align the proposal template with the BEC bundle contract.
The bundle format persists paths, severity, and optionally rejected_alternatives, but this template asks for Language(s) instead. That leaves proposals underspecified and forces extra back-and-forth when turning them into catalog entries.
Suggested update
**Intent** — what should this rule enforce?
**Why it matters** — what breaks if it is violated?
**Check** — how would it be detected? (a `forbid` regex, a built-in check, or a
custom script)
-**Language(s)** — Python, JS/TS, any, ...
+**Affected paths** — which files or patterns should this rule cover?
+
+**Rejected alternatives** — what other approaches did you rule out?
**Severity** — `blocking` or `warning`, and why.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **Intent** — what should this rule enforce? | |
| **Why it matters** — what breaks if it is violated? | |
| **Check** — how would it be detected? (a `forbid` regex, a built-in check, or a | |
| custom script) | |
| **Language(s)** — Python, JS/TS, any, ... | |
| **Severity** — `blocking` or `warning`, and why. | |
| **Intent** — what should this rule enforce? | |
| **Why it matters** — what breaks if it is violated? | |
| **Check** — how would it be detected? (a `forbid` regex, a built-in check, or a | |
| custom script) | |
| **Affected paths** — which files or patterns should this rule cover? | |
| **Rejected alternatives** — what other approaches did you rule out? | |
| **Severity** — `blocking` or `warning`, and why. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.github/ISSUE_TEMPLATE/bec_proposal.md around lines 8 - 17, The proposal
template sections are mismatched with the BEC bundle contract: it asks for
Language(s) instead of the fields the bundle actually persists. Update the
bec_proposal template to collect the bundle-aligned metadata using the existing
Intent/Why it matters/Check/Severity structure, and replace the Language(s)
prompt with the contract-backed fields such as paths, severity, and optionally
rejected_alternatives so proposals can map cleanly into catalog entries.
| **Rule / check involved** (if any) | ||
| The `.bec/rules.yaml` rule or the `check` command, if relevant. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Point reporters at the actual BEC bundle path.
becs/<id>.bec.yaml is the repo’s BEC format, so .bec/rules.yaml will send people to the wrong place and make reports harder to triage. Please update this prompt to reference the bundle path (or the check command) instead.
Suggested fix
-**Rule / check involved** (if any)
-The `.bec/rules.yaml` rule or the `check` command, if relevant.
+**Rule / check involved** (if any)
+The `becs/<id>.bec.yaml` bundle or the `check` command, if relevant.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **Rule / check involved** (if any) | |
| The `.bec/rules.yaml` rule or the `check` command, if relevant. | |
| **Rule / check involved** (if any) | |
| The `becs/<id>.bec.yaml` bundle or the `check` command, if relevant. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.github/ISSUE_TEMPLATE/bug_report.md around lines 23 - 24, The bug report
template is pointing reporters to the wrong BEC reference, so update the “Rule /
check involved” prompt in the bug_report template to mention the actual bundle
path used by the repo’s BEC format or the check command instead of
`.bec/rules.yaml`. Keep the wording aligned with the existing template section
and use the relevant prompt text in the bug report markdown to guide reporters
to `becs/<id>.bec.yaml` or the command they should run.
1 participant
Adds community scaffolding for the public repo:
Summary by CodeRabbit
Documentation
New Features