docs: add comprehensive release process documentation #83
Conversation
- Add RELEASE_PROCESS.md with step-by-step development workflow - Include branch naming conventions and PR template structure - Document critical rules for git operations and permissions - Update CLAUDE.md to reference new release process documentation
|
Cursor review |
WalkthroughA new section on the release process was added to the main documentation, and a comprehensive release process guideline was introduced in a dedicated file. These changes establish a standardized workflow for development, including branch management, commit practices, pull request procedures, and critical rules for repository contributions. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
Claude finished @cameroncooke's task —— View job PR Review: Release Process DocumentationI've completed my review of this release process documentation PR. Here's my comprehensive feedback: Review Tasks:
✅ Strengths1. Security Best Practices
2. Documentation Quality
3. Process Completeness
|
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
✅ Bugbot reviewed your changes and found no bugs!
Bugbot free trial expires on August 7, 2025
Learn more in the Cursor dashboard.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/RELEASE_PROCESS.md (3)
13-18: Clarify the twogit checkout -bexamples or separate themBoth commands are presented in the same code block without context, so copy-pasting will attempt to create two branches in a row (the second replaces the first). This can confuse newcomers.
git checkout -b feature/issue-123-add-new-feature -git checkout -b bugfix/issue-456-fix-simulator-crash +# …or for a bug-fix: +git checkout -b bugfix/issue-456-fix-simulator-crash
34-38: Convert the emphasised line to a proper heading to satisfy MD036Markdown-lint flags “Emphasis used instead of a heading”. Turning it into a fourth-level heading keeps the visual weight while silencing the linter.
-**🚨 CRITICAL: Always ask permission before pushing** +#### 🚨 CRITICAL: Always ask permission before pushing
48-82: Here-doc quoting will break when copy-pastedThe nested
$(cat <<'EOF' … EOF)is nice for advanced users, but most devs will paste this into a shell that lacks the$()context (it will just outputEOFon stdout). Consider a simpler example or add a short note explaining the context.CLAUDE.md (1)
168-173: Use a standard Markdown link to the new document
@docs/RELEASE_PROCESS.mdwon’t render as a clickable link on GitHub. Replace with a relative Markdown link.-For complete guidelines, refer to @docs/RELEASE_PROCESS.md +For complete guidelines, refer to the [Release Process](docs/RELEASE_PROCESS.md).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
CLAUDE.md(1 hunks)docs/RELEASE_PROCESS.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: CR
PR: cameroncooke/XcodeBuildMCP#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-22T19:54:09.554Z
Learning: Update documentation for new features.
Learnt from: CR
PR: cameroncooke/XcodeBuildMCP#0
File: .cursorrules:0-0
Timestamp: 2025-07-22T19:53:45.001Z
Learning: All changes must pass linting and formatting checks before merging
CLAUDE.md (3)
Learnt from: CR
PR: cameroncooke/XcodeBuildMCP#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-22T19:54:09.554Z
Learning: Update documentation for new features.
Learnt from: CR
PR: cameroncooke/XcodeBuildMCP#0
File: .cursorrules:0-0
Timestamp: 2025-07-22T19:53:45.001Z
Learning: Applies to CHANGELOG.md : Update CHANGELOG.md when adding or updating tools or dependencies
Learnt from: CR
PR: cameroncooke/XcodeBuildMCP#0
File: .cursorrules:0-0
Timestamp: 2025-07-22T19:53:45.001Z
Learning: All changes must pass linting and formatting checks before merging
docs/RELEASE_PROCESS.md (3)
Learnt from: CR
PR: cameroncooke/XcodeBuildMCP#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-22T19:54:09.554Z
Learning: Update documentation for new features.
Learnt from: CR
PR: cameroncooke/XcodeBuildMCP#0
File: .cursorrules:0-0
Timestamp: 2025-07-22T19:53:45.001Z
Learning: Applies to CHANGELOG.md : Update CHANGELOG.md when adding or updating tools or dependencies
Learnt from: CR
PR: cameroncooke/XcodeBuildMCP#0
File: .cursorrules:0-0
Timestamp: 2025-07-22T19:53:45.001Z
Learning: All changes must pass linting and formatting checks before merging
🪛 markdownlint-cli2 (0.17.2)
docs/RELEASE_PROCESS.md
34-34: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Cursor Bugbot
- GitHub Check: claude-review
1 participant
Summary
Add comprehensive release process documentation to establish standardized development workflow with feature branches, structured pull requests, and linear commit history.
Background/Details
For New Features:
Solution
docs/RELEASE_PROCESS.mdwith step-by-step development workflowfeature/,bugfix/,hotfix/, etc.)CLAUDE.mdto reference the new release process documentationTesting
Notes
Summary by CodeRabbit