Skip to content

ACM-33619 Add dev workflow docs and fix CLAUDE.md port values#6218

Draft
Randy424 wants to merge 1 commit into
stolostron:mainfrom
Randy424:acm-33619-readme-updates
Draft

ACM-33619 Add dev workflow docs and fix CLAUDE.md port values#6218
Randy424 wants to merge 1 commit into
stolostron:mainfrom
Randy424:acm-33619-readme-updates

Conversation

@Randy424
Copy link
Copy Markdown
Contributor

@Randy424 Randy424 commented May 15, 2026

Summary

  • Add Testing, Linting/Formatting, Building, i18n, and Commit Requirements subsections to README.md under ## Development
  • Fix swapped ACM_PORT/MCE_PORT default values in CLAUDE.md to match port-defaults.sh

Details

README.md — New contributors currently have no documentation on how to run tests, lint, build, or handle i18n. The Signed-off-by commit 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.mdACM_PORT and MCE_PORT defaults were swapped (3001/3002 reversed). Corrected to match port-defaults.sh: MCE=3001, ACM=3002.

Test plan

  • Verify all documented npm scripts exist in package.json
  • Verify port values match port-defaults.sh
  • Review markdown renders correctly on GitHub

🤖 Generated with Claude Code

Summary by CodeRabbit

Documentation

  • Reordered port configuration entries for clearer presentation.
  • Added a new "Development" section with instructions for testing, linting & formatting, building, internationalization checks/fixes, and commit signing requirements.

@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 15, 2026

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 15, 2026

[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

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 15, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 5f9b920f-7fe0-4cad-8e25-a1d479539f30

📥 Commits

Reviewing files that changed from the base of the PR and between 69b0ec2 and ab1d482.

📒 Files selected for processing (2)
  • CLAUDE.md
  • README.md
✅ Files skipped from review due to trivial changes (2)
  • CLAUDE.md
  • README.md

📝 Walkthrough

Walkthrough

This 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.

Changes

Documentation Updates

Layer / File(s) Summary
Port configuration reordering
CLAUDE.md
Port Configuration list reordered to document MCE_PORT (default 3001) before ACM_PORT (default 3002).
Development guidelines
README.md
New Development section added covering testing commands with pattern filtering, linting and formatting checks and auto-fixes, production build command, i18n validation and fix commands, and Commit Requirements describing required Signed-off-by trailer with git commit -s usage.

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description includes a clear summary of changes, detailed rationale, and a test plan with checkboxes. However, it does not follow the required PR template structure with sections like 'Type of Change' or the full General/Feature/Bugfix checklist. Align description with the repository template by including 'Type of Change' selection, completing the General checklist items, and organizing content under the specified sections.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the ticket (ACM-33619) and summarizes both main changes: dev workflow documentation and port value corrections in CLAUDE.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between f4dcdb0 and 69b0ec2.

📒 Files selected for processing (2)
  • CLAUDE.md
  • README.md

Comment thread README.md Outdated
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>
@Randy424 Randy424 force-pushed the acm-33619-readme-updates branch from 69b0ec2 to ab1d482 Compare May 15, 2026 20:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant