Skip to content

Improve AI-assisted development readiness: AGENTS.md, templates, .gitignore, pre-commit hooks [Generated by gurnben's Agent]#245

Open
gurnben wants to merge 1 commit into
openshift-online:mainfrom
gurnben:agent-readiness-improvements
Open

Improve AI-assisted development readiness: AGENTS.md, templates, .gitignore, pre-commit hooks [Generated by gurnben's Agent]#245
gurnben wants to merge 1 commit into
openshift-online:mainfrom
gurnben:agent-readiness-improvements

Conversation

@gurnben
Copy link
Copy Markdown

@gurnben gurnben commented Apr 20, 2026

Summary

Adds foundational agent-readiness infrastructure to this repository.

Changes

  • AGENTS.md + CLAUDE.md — AI coding assistant guidance with build commands, architecture overview, and key conventions (AGENTS.md is tool-agnostic; CLAUDE.md is a copy for Claude Code compatibility)
  • PR & Issue templates — standardized .github/PULL_REQUEST_TEMPLATE.md, bug report, and feature request templates
  • .gitignore — expanded with language-specific and IDE/OS patterns
  • .pre-commit-config.yaml — pre-commit hooks for automated code quality checks

AgentReady Score Impact

This PR is part of an organization-wide initiative to improve AI-assisted development readiness across openshift-online, measured by AgentReady (v2.31.2).

Metric Value
Current score 31.0/100 (Needs Improvement)
This PR +17 points
Score after this PR 48/100 (Bronze)
All open PRs combined +32 points63/100 (Silver)

Attributes addressed by this PR

  • CLAUDE.md/AGENTS.md (+10)
  • PR/Issue templates (+1)
  • .gitignore (+3)
  • Pre-commit hooks (+3)

Context

All content was derived from this repository's actual Makefile targets, go.mod, existing documentation, and code structure. No placeholder content.

Testing

  • No functional code changes — documentation and tooling only
  • Pre-commit hooks can be tested with pre-commit run --all-files

:robot_face: This PR was generated by an AI agent (Claude) as part of an organization-wide initiative to improve AI-assisted development readiness across openshift-online. The agent assessed all 32 public repositories using AgentReady, identified improvement opportunities, generated the changes, and opened this PR. All commits are GPG-signed by @gurnben.

@openshift-ci openshift-ci Bot requested review from ahitacat and nimrodshn April 20, 2026 17:35
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 20, 2026

Warning

Rate limit exceeded

@gurnben has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 30 minutes and 1 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 30 minutes and 1 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 2090e241-ef72-4406-b26f-f902d742233f

📥 Commits

Reviewing files that changed from the base of the PR and between 2420432 and 465c7c4.

📒 Files selected for processing (7)
  • .github/ISSUE_TEMPLATE/bug_report.md
  • .github/ISSUE_TEMPLATE/feature_request.md
  • .github/PULL_REQUEST_TEMPLATE.md
  • .gitignore
  • .pre-commit-config.yaml
  • AGENTS.md
  • CLAUDE.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with 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.

❤️ Share

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

@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented Apr 20, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: gurnben
Once this PR has been reviewed and has the lgtm label, please assign vkareh for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

@gurnben gurnben force-pushed the agent-readiness-improvements branch from c7e6a58 to 465c7c4 Compare April 20, 2026 18:05
@gurnben gurnben changed the title Improve AI-assisted development readiness: AGENTS.md, templates, .gitignore, pre-commit hooks Improve AI-assisted development readiness: AGENTS.md, templates, .gitignore, pre-commit hooks [Generated by gurnben's Agent] Apr 21, 2026
Comment thread .pre-commit-config.yaml
- repo: https://github.com/golangci/golangci-lint
rev: v2.1.2
hooks:
- id: golangci-lint
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

What are the implications of this change?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

This adds a .pre-commit-config.yaml that developers can opt into by running pre-commit install. It configures hooks that run automatically before each commit to catch common issues:

  • trailing-whitespace / end-of-file-fixer — consistent formatting
  • check-yaml — catches YAML syntax errors before push
  • check-added-large-files — prevents accidentally committing binaries >500KB
  • check-merge-conflict — catches leftover conflict markers
  • golangci-lint — runs the standard Go linter

It's entirely opt-in — developers who don't run pre-commit install are unaffected. No CI changes, no enforcement. It's there for developers (and AI agents) who want automated quality checks locally.

Comment thread .gitignore

# Build output
/bin/
/dist/
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Any need for this change?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

The existing .gitignore covered the project-specific patterns (vendor, model, generated code, bin). This extends it with standard Go ecosystem and developer tooling patterns that were missing:

  • Go build artifacts (*.test, *.out, *.prof, go.work) — prevents committing test binaries and coverage output
  • IDE files (.idea/, .vscode/, *.swp) — keeps editor configs out of the repo
  • OS files (.DS_Store, Thumbs.db) — common cross-platform noise

These are standard patterns from github/gitignore that most Go repos include. Happy to trim any specific patterns if you'd prefer a smaller set.

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.

2 participants