docs: add issue title naming convention#570
Conversation
|
Warning Review limit reached
More reviews will be available in 22 minutes and 23 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
WalkthroughDas Pull Request führt eine konsistente Namengebung für Issue-Titel ein: neue GitHub Issue-Templates für Vertrags- und Prozessvorschläge definieren Titelpräfixe und Formularfelder, während erweiterte Beitragrichtlinien in Deutsch und Englisch die Konvention dokumentieren und Guidelines zur Anwendung bereitstellen. ChangesIssue-Titel-Konvention und Templates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 Minuten 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 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 `@CONTRIBUTING.adoc`:
- Around line 315-318: Replace the Markdown list markers (`-`) with AsciiDoc
unordered-list markers (`*`) for the four bullet lines that start with "Use the
issue template...", "Free-form issues...", "Apply going forward only...", and
"EPICs use the bare `EPIC:`..." so the block uses AsciiDoc syntax; keep the text
unchanged aside from the leading marker and ensure there is a blank line before
the list if needed for proper AsciiDoc rendering.
In `@docs/CONTRIBUTING.de.adoc`:
- Around line 228-231: Replace the hyphen list markers with AsciiDoc unordered
list markers in the German CONTRIBUTING doc: change the four list items
currently starting with "-" to start with "*" so the lines beginning with
"Verwenden Sie das Issue-Template", "Frei formulierte Issues", "Nur zukünftig
anwenden" and "EPICs verwenden das bloße `EPIC:` Prefix" use AsciiDoc's
unordered marker `*` (not Markdown `-`) to conform to the "*.adoc" guideline.
🪄 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: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
Run ID: 72f8b38c-ef29-47bc-aeff-181dbd59ba5d
📒 Files selected for processing (5)
.github/ISSUE_TEMPLATE/contract-proposal.yml.github/ISSUE_TEMPLATE/process-proposal.ymlCONTRIBUTING.adocCONTRIBUTING.mddocs/CONTRIBUTING.de.adoc
2 participants
Summary
Implements the naming convention agreed upon in #564.
Changes
[Type]: <Name>prefixes and guidelines (apply going forward only, EPIC as sanctioned exception).[Contract Proposal]:issues.[Process Proposal]:issues.What was NOT included (by design)
Tested
Closes #564
Summary by CodeRabbit
Release Notes
Dokumentation
[Contract Proposal],[Process Proposal],[Bug]undEPIC:Chores