ACM-33619 Add dev workflow docs and fix CLAUDE.md port values#6218
ACM-33619 Add dev workflow docs and fix CLAUDE.md port values#6218Randy424 wants to merge 1 commit into
Conversation
|
Skipping CI for Draft Pull Request. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Randy424 The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughThis PR updates documentation: CLAUDE.md reorders two port entries, and README.md adds a Development section with testing, linting/formatting, build, i18n, and commit Signed-off-by guidance. ChangesDocumentation Updates
🎯 1 (Trivial) | ⏱️ ~5 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 `@README.md`:
- Around line 242-244: The fenced code block containing "Signed-off-by: Your
Name <your.email@example.com>" in README.md lacks a language identifier (causing
markdownlint MD040); update that fence (the triple-backtick block around the
signed-off line) to include an appropriate language tag such as text (e.g.,
```text) so the block is explicitly typed and the linter error is resolved.
🪄 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.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: b11bc165-5f1a-4724-9059-1a84570042ae
📒 Files selected for processing (2)
CLAUDE.mdREADME.md
Add Testing, Linting, Building, i18n, and Commit Requirements sections to README.md under Development. Fix swapped ACM_PORT and MCE_PORT defaults in CLAUDE.md to match port-defaults.sh. Signed-off-by: Randy Bruno Piverger <21374229+Randy424@users.noreply.github.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
69b0ec2 to
ab1d482
Compare
Summary
## DevelopmentACM_PORT/MCE_PORTdefault values in CLAUDE.md to matchport-defaults.shDetails
README.md — New contributors currently have no documentation on how to run tests, lint, build, or handle i18n. The
Signed-off-bycommit requirement (enforced by Husky) is also undocumented, causing first-time contributors to have commits rejected with no explanation. This PR adds five new subsections covering all of these.CLAUDE.md —
ACM_PORTandMCE_PORTdefaults were swapped (3001/3002 reversed). Corrected to matchport-defaults.sh: MCE=3001, ACM=3002.Test plan
package.jsonport-defaults.sh🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation