Skip to content

fix: Added updates for agent readiness using PatternFly MCP agent ready skill#43

Open
dlabaj wants to merge 1 commit into
patternfly:mainfrom
dlabaj:agentReadyPFMCP
Open

fix: Added updates for agent readiness using PatternFly MCP agent ready skill#43
dlabaj wants to merge 1 commit into
patternfly:mainfrom
dlabaj:agentReadyPFMCP

Conversation

@dlabaj
Copy link
Copy Markdown
Contributor

@dlabaj dlabaj commented May 11, 2026

Updated to bring agent readiness into Gold standard for this repo. Current results are now:

   
Score 76.5 / 100
Level Gold
Assessed 21 / 31 attributes (10 skipped / N/A; 2 excluded by config)

Summary by CodeRabbit

  • Documentation

    • Added contributor guidelines and architectural decision records to aid project contributors.
  • Chores

    • Consolidated and streamlined CI/CD workflows for improved build and test automation.
    • Implemented commit message validation and pre-commit hooks.
    • Added issue and pull request templates to standardize contributor submissions.

Review Change Stack

@dlabaj dlabaj requested a review from jpuzz0 May 11, 2026 21:19
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 11, 2026

Walkthrough

This PR establishes comprehensive development infrastructure for the PatternFly CLI: documentation conventions and architecture decisions, consolidated CI pipeline combining build/lint/test workflows, commit message validation via Commitlint and Husky, GitHub issue and PR templates for structured contributions, and standardized repository configuration.

Changes

Development Infrastructure and Conventions

Layer / File(s) Summary
Repository Conventions and Architecture Documentation
AGENTS.md, docs/adr/README.md, docs/adr/0001-cli-entrypoint-and-command-modules.md, docs/adr/0002-tests-under-src-instead-of-root-tests.md
Establishes tech stack, directory layout, and development patterns: Node.js and TypeScript with ES modules, CLI entry point at src/cli.ts delegating to command modules with exported run* functions, and Jest tests co-located under src/__tests__/ instead of a root-level tests/ directory.
CI/Build Pipeline Consolidation
.github/workflows/ci.yml (new), .github/workflows/build.yml, .github/workflows/lint.yml, .github/workflows/test.yml (removed), .github/workflows/release.yml, package.json
Replaces separate build, lint, and test workflows with unified ci.yml containing quality-gates and commitlint jobs; updates release.yml to include linting step; adds npm scripts for test:file, typecheck, lint:fix, and lint:file.
Commit Message Validation Setup
commitlint.config.mjs, .husky/commit-msg, package.json
Configures Commitlint with conventional commit ruleset, installs Husky git hook for commit-msg validation, and adds @commitlint/cli and @commitlint/config-conventional dependencies with husky and prepare script.
GitHub Issue and PR Templates
.github/ISSUE_TEMPLATE/bug_report.yml, .github/ISSUE_TEMPLATE/config.yml, .github/ISSUE_TEMPLATE/feature_request.yml, .github/pull_request_template.md
Adds structured issue templates for bug reports and feature requests with required/optional fields, enables blank issues, provides contact links to PatternFly docs and React repo, and creates PR template with testing checklist and contribution guidelines.
Repository Configuration and Cleanup
.agentready-config.yaml, .gitignore, tsconfig.json
Adds AgentReady config excluding cyclomatic complexity and layout checks; standardizes .gitignore with normalized patterns for dependencies (node_modules/), build output (dist/), coverage/test artifacts, logs, environment files, caches, tooling output (.agentready/, .repomix-output/), and OS/editor files; reformats tsconfig.json arrays for consistency.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested reviewers

  • jpuzz0
  • wise-king-sullyman
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title describes adding agent readiness configuration and updates, which directly aligns with the main changes in the PR (config files, workflows, and documentation for repo standards).
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

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

❤️ Share

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

Copy link
Copy Markdown
Contributor

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

🧹 Nitpick comments (1)
.github/pull_request_template.md (1)

11-13: ⚡ Quick win

Align checklist with CI by including local build validation.

Adding npm run build here keeps contributor checks consistent with CI gates.

Proposed tweak
 - [ ] Tests added or updated where appropriate
-- [ ] `npm run lint` and `npm test` pass locally
+- [ ] `npm run lint`, `npm run build`, and `npm test` pass locally
 - [ ] Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) (required for semantic-release), e.g. `feat:`, `fix:`, `docs:`, `chore:`
🤖 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 @.github/pull_request_template.md around lines 11 - 13, Update the PR
checklist to include local build validation by adding a new checkbox item for
running the build command (e.g., add "- [ ] `npm run build`" alongside the
existing npm lint/test items) in the .github/pull_request_template.md so
contributors run the same local build step enforced by CI.
🤖 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.

Nitpick comments:
In @.github/pull_request_template.md:
- Around line 11-13: Update the PR checklist to include local build validation
by adding a new checkbox item for running the build command (e.g., add "- [ ]
`npm run build`" alongside the existing npm lint/test items) in the
.github/pull_request_template.md so contributors run the same local build step
enforced by CI.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 21f8fb7a-5b96-4039-974c-9195025cc3f5

📥 Commits

Reviewing files that changed from the base of the PR and between 9635cb8 and 55ba4b7.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (19)
  • .agentready-config.yaml
  • .github/ISSUE_TEMPLATE/bug_report.yml
  • .github/ISSUE_TEMPLATE/config.yml
  • .github/ISSUE_TEMPLATE/feature_request.yml
  • .github/pull_request_template.md
  • .github/workflows/build.yml
  • .github/workflows/ci.yml
  • .github/workflows/lint.yml
  • .github/workflows/release.yml
  • .github/workflows/test.yml
  • .gitignore
  • .husky/commit-msg
  • AGENTS.md
  • commitlint.config.mjs
  • docs/adr/0001-cli-entrypoint-and-command-modules.md
  • docs/adr/0002-tests-under-src-instead-of-root-tests.md
  • docs/adr/README.md
  • package.json
  • tsconfig.json
💤 Files with no reviewable changes (3)
  • .github/workflows/lint.yml
  • .github/workflows/test.yml
  • .github/workflows/build.yml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant