docs: add CONTRIBUTING + RELEASING; draft release on tag push - #745
Conversation
- CONTRIBUTING.md: dev setup, CI gates (fmt/clippy/coverage/e2e/generated- artifact drift), conventional-commit and squash-merge PR style, Apache-2.0 inbound=outbound. - RELEASING.md: the release order (DP tag -> images -> polished notes -> publish -> downstream packaging pins the version) and the release-notes house style. - release-draft.yml: on a vX.Y.Z tag push, create a draft GitHub Release with auto-generated notes for a maintainer to polish; no-op when a release already exists. - README: link CONTRIBUTING.md from the Community section.
|
Warning Review limit reached
Next review available in: 53 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughAdds a new GitHub Actions workflow that creates draft GitHub releases on version tag pushes, introduces CONTRIBUTING.md documenting contribution setup, CI checks, and commit conventions, adds RELEASING.md describing the release process, and links CONTRIBUTING.md from README.md. ChangesContribution and Release Process Documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
✨ 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.md`:
- Around line 51-53: The example code fence in CONTRIBUTING.md is unlabeled and
triggers markdownlint MD040; update the fenced block around the commit message
example to include a language hint such as text so the documentation passes
linting. Use the existing example snippet with the <type>(<scope>): <imperative
summary> placeholder and keep the rest of the formatting unchanged.
In `@RELEASING.md`:
- Around line 39-45: Update the release notes template in RELEASING.md so the
Full changelog compare link uses the actual previous release tag instead of the
hardcoded vX.Y.(Z-1) pattern. Adjust the changelog reference near the install
snippet to use a generic previous-tag placeholder or the real prior tag, and
keep the docker pull example unchanged.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 1f6a3da3-8693-422c-a04f-fae2ab3c3bec
📒 Files selected for processing (4)
.github/workflows/release-draft.ymlCONTRIBUTING.mdREADME.mdRELEASING.md
| ``` | ||
| <type>(<scope>): <imperative summary> | ||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Label the example code fence.
The unlabeled fenced block trips markdownlint (MD040). Add a language hint such as text so the docs pass the configured lint rule.
♻️ Proposed fix
-```
+```text
<type>(<scope>): <imperative summary>
-```
+```📝 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.
| ``` | |
| <type>(<scope>): <imperative summary> | |
| ``` |
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 51-51: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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 `@CONTRIBUTING.md` around lines 51 - 53, The example code fence in
CONTRIBUTING.md is unlabeled and triggers markdownlint MD040; update the fenced
block around the commit message example to include a language hint such as text
so the documentation passes linting. Use the existing example snippet with the
<type>(<scope>): <imperative summary> placeholder and keep the rest of the
formatting unchanged.
Source: Linters/SAST tools
…ort, prerelease drafts)
|
Independent audit (cold-context agent) completed on eee79a3: 0 HIGH / 1 MEDIUM / 4 LOW — verdict FIX FIRST, addressed in 654a8db:
Audit also verified: draft-guard finds draft releases (gh |
1 participant
What
Two of the launch-prep items: a contributor entry point, and "tag → release notes" fixed into the release process.
.github/workflows/release-draft.yml— on avX.Y.Ztag push, creates a draft GitHub Release with auto-generated notes as the skeleton a maintainer polishes before publishing. Drafts don't notify watchers; the workflow is a no-op when a release for the tag already exists.Test plan
gh release viewguard verified against existing tags (v0.1.0–v0.3.1 already have releases → workflow no-ops)Docs + CI-workflow only — no runtime surface.
Summary by CodeRabbit
New Features
Documentation