Skip to content

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

Merged
rcampos2029 merged 2 commits into
openshift-online:mainfrom
gurnben:agent-readiness-improvements
Apr 30, 2026
Merged

Improve AI-assisted development readiness: AGENTS.md, templates, .gitignore, pre-commit hooks [Generated by gurnben's Agent]#1100
rcampos2029 merged 2 commits into
openshift-online:mainfrom
gurnben:agent-readiness-improvements

Conversation

@gurnben
Copy link
Copy Markdown
Contributor

@gurnben gurnben commented Apr 20, 2026

Summary

Adds foundational agent-readiness infrastructure to this repository.

Changes

  • AGENTS.md — tool-agnostic AI coding assistant guidance with build commands, architecture overview, and key conventions (complements the existing CLAUDE.md already on main)
  • 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 63.6/100 (Silver)
This PR +17 points
Score after this PR 81/100 (Gold)

Attributes addressed by this PR

  • 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 CLAUDE.md, and code structure. No placeholder content. The AGENTS.md is a condensed, tool-agnostic version of the existing CLAUDE.md.

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.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 20, 2026

Summary by CodeRabbit

  • Documentation

    • Added standardized issue templates for bug reports and feature requests to improve issue quality and consistency.
  • Chores

    • Enhanced pre-commit hooks configuration for code quality checks.
    • Expanded .gitignore to exclude build artifacts and IDE files.
    • Added pull request template to streamline contribution process.

Walkthrough

Adds GitHub issue templates for bug reports and feature requests, a pull request template, extends .gitignore patterns, introduces pre-commit hook configuration, and creates developer documentation outlining the codebase structure and conventions for AI coding assistants.

Changes

Cohort / File(s) Summary
GitHub Templates
.github/ISSUE_TEMPLATE/bug_report.md, .github/ISSUE_TEMPLATE/feature_request.md, .github/PULL_REQUEST_TEMPLATE.md
Introduces structured templates with YAML metadata and form fields to standardize issue and pull request submissions, including bug descriptions, reproduction steps, change types, and testing verification checklists.
Configuration & Ignore Rules
.gitignore, .pre-commit-config.yaml
Extends .gitignore to exclude binaries, test artifacts, editor files, and build directories; adds pre-commit hooks for whitespace, YAML validation, large files, and golangci-lint v2.1.2.
Developer Documentation
AGENTS.md
Documents codebase structure for AI assistants, including CLI architecture, common make commands, key packages, authentication patterns, and project conventions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: adding AGENTS.md, templates, .gitignore, and pre-commit hooks for AI-assisted development readiness.
Description check ✅ Passed The description comprehensively covers all files changed and their purpose, aligning with the changeset of documentation and tooling improvements.
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

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
Review rate limit: 0/1 reviews remaining, refill in 60 minutes.

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 rcampos2029 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 97fa1b6 to cf2ad06 Compare April 20, 2026 18:05
@gurnben
Copy link
Copy Markdown
Contributor Author

gurnben commented Apr 21, 2026

CI Note: enterprise-contract failure is pre-existing

The Red Hat Konflux / ocm-cli-enterprise-contract / ocm-cli check is failing, but this is not caused by this PR. The same check is currently failing on every open PR in this repo:

This PR only adds documentation and tooling files (AGENTS.md, templates, .gitignore, pre-commit config) — no Go code or build changes.

If there's anything I can do to help investigate or resolve the Konflux pipeline issue, happy to assist — just let me know what access or context would be needed.

@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
@ciaranRoche
Copy link
Copy Markdown
Collaborator

/ok-to-test

@openshift-ci openshift-ci Bot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Apr 27, 2026
@ciaranRoche
Copy link
Copy Markdown
Collaborator

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Apr 27, 2026
@gurnben
Copy link
Copy Markdown
Contributor Author

gurnben commented Apr 29, 2026

Friendly nudge — this has lgtm and ok-to-test. Just needs /approve from an approver to merge. All changes are doc/config only (AGENTS.md, templates, .gitignore, pre-commit hooks).

Adds the missing AGENTS.md file that was referenced in the PR
description but not included. Content is derived from the existing
CLAUDE.md already present on main, adapted to be tool-agnostic.
@openshift-ci openshift-ci Bot removed the lgtm Indicates that a PR is ready to be merged. label Apr 30, 2026
@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented Apr 30, 2026

New changes are detected. LGTM label has been removed.

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.

🧹 Nitpick comments (1)
.gitignore (1)

29-30: 💤 Low value

Minor redundancy with existing patterns.

Lines 29-30 add .idea/ and .vscode/ patterns, but lines 7 and 4 already have /.idea and /.vscode. The new patterns (without leading slash) are more general and will match these directories at any level, making the older patterns redundant. Consider removing the root-only patterns from lines 4 and 7 to avoid duplication.

🧹 Optional cleanup to remove redundant patterns

Consider removing the redundant root-only patterns:

 *.orig
 *.patch
 *.rej
-/.vscode
 /ocm
 /ocm-*
-/.idea

The more general patterns .vscode/ and .idea/ at lines 30 and 29 will handle these directories at any level in the repository.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.gitignore around lines 29 - 30, Remove the redundant root-only ignore
patterns by deleting "/.idea" and "/.vscode" entries and keep the more general
".idea/" and ".vscode/" patterns (or vice versa) so the repository only contains
one form; locate the entries referencing "/.idea" and "/.vscode" and remove them
to avoid duplication with the existing ".idea/" and ".vscode/" patterns.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.gitignore:
- Around line 29-30: Remove the redundant root-only ignore patterns by deleting
"/.idea" and "/.vscode" entries and keep the more general ".idea/" and
".vscode/" patterns (or vice versa) so the repository only contains one form;
locate the entries referencing "/.idea" and "/.vscode" and remove them to avoid
duplication with the existing ".idea/" and ".vscode/" patterns.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: 4b9478d5-9a5e-402f-b8a3-9b1d45620d0e

📥 Commits

Reviewing files that changed from the base of the PR and between f80645d and f121526.

📒 Files selected for processing (6)
  • .github/ISSUE_TEMPLATE/bug_report.md
  • .github/ISSUE_TEMPLATE/feature_request.md
  • .github/PULL_REQUEST_TEMPLATE.md
  • .gitignore
  • .pre-commit-config.yaml
  • AGENTS.md

@rcampos2029 rcampos2029 merged commit bd2ae48 into openshift-online:main Apr 30, 2026
10 of 12 checks passed
@rcampos2029 rcampos2029 mentioned this pull request May 14, 2026
13 tasks
rcampos2029 added a commit that referenced this pull request May 14, 2026
- Add one-command build/setup: README.md (Quick Start section)
- chore(deps): update module github.com/go-jose/go-jose/v4 to v4.1.4
- OSDGCP-2 | feat: Improve AI-assisted development readiness: AGENTS.md, templates, .gitignore, pre-commit hooks [Generated by gurnben's Agent] (#1100)
- chore: Bump Go to 1.25 and golangci-lint to v2.12.1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ok-to-test Indicates a non-member PR verified by an org member that is safe to test.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants