Skip to content

Add AGENTS.md guide for AI coding assistants#434

Draft
lsm5 wants to merge 1 commit intocontainers:mainfrom
lsm5:agents-md
Draft

Add AGENTS.md guide for AI coding assistants#434
lsm5 wants to merge 1 commit intocontainers:mainfrom
lsm5:agents-md

Conversation

@lsm5
Copy link
Copy Markdown
Member

@lsm5 lsm5 commented Jan 5, 2026

Similar to https://github.com/containers/podman/blob/main/AGENTS.md, this provides context and guidance for AI agents working with container-selinux development, including SELinux policy structure, testing patterns, and common pitfalls.

Summary by Sourcery

Documentation:

  • Introduce AGENTS.md with guidance for AI coding assistants on SELinux policy structure, testing workflows, platform nuances, and common pitfalls when working on container-selinux.

Similar to https://github.com/containers/podman/blob/main/AGENTS.md,
this provides context and guidance for AI agents working with
container-selinux development, including SELinux policy structure,
testing patterns, and common pitfalls.

Signed-off-by: Lokesh Mandvekar <[email protected]>
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Jan 5, 2026

Reviewer's Guide

Adds a new AGENTS.md guide targeted at AI coding assistants, documenting project context, development workflows, policy structure, testing, and pitfalls for working on container-selinux.

File-Level Changes

Change Details Files
Introduce AGENTS.md as a comprehensive guide for AI coding assistants contributing to container-selinux.
  • Describe project purpose and quick-start build/test commands for container-selinux.
  • Document codebase layout, SELinux policy module components (.te, .if, .fc) and Udica CIL templates.
  • Outline testing strategy using BATS and Podman SELinux tests, including manual verification commands.
  • Capture code standards, platform-specific (RHEL/Fedora) considerations, key SELinux booleans, and essential tooling.
  • List common pitfalls for AI agents and reference related documentation such as CLAUDE.md, README, spec file, Packit config, and external SELinux/Udica resources.
AGENTS.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello @lsm5, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new AGENTS.md guide, specifically tailored for AI coding assistants. Its purpose is to equip AI agents with the necessary context and guidelines for effective contribution to container-selinux development, covering critical aspects like SELinux policy structure, testing methodologies, and common development challenges, thereby streamlining their integration into the project's workflow.

Highlights

  • New AI Agent Guide: A new AGENTS.md file has been added, providing a dedicated guide for AI coding assistants working on container-selinux development.
  • Comprehensive Development Context: The guide offers extensive context on SELinux policy structure, development patterns, testing frameworks, and common pitfalls specific to container-selinux.
  • Essential Resources: It includes quick start commands, codebase structure overview, key SELinux tunables, important tools and libraries, and essential commands for policy analysis, development, debugging, and testing.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces an AGENTS.md file, which serves as a comprehensive guide for AI coding assistants working with the container-selinux repository. The document is well-structured and covers important aspects like project overview, codebase structure, development patterns, testing, and common pitfalls. This is a valuable addition for automating and assisting with development tasks. I have one minor suggestion regarding a broken link in the documentation section.

Comment thread AGENTS.md

## Documentation

- **[CLAUDE.md](CLAUDE.md)**: Project-specific guidance for Claude Code
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

This line references CLAUDE.md, but this file does not appear to exist in the repository, which will result in a broken link. Please consider either adding the CLAUDE.md file in this or a subsequent pull request, or removing this reference if it's not intended to be included.

@packit-as-a-service
Copy link
Copy Markdown

Ephemeral COPR build failed. @containers/packit-build please check.

1 similar comment
@packit-as-a-service
Copy link
Copy Markdown

Ephemeral COPR build failed. @containers/packit-build please check.

@packit-as-a-service
Copy link
Copy Markdown

Tests failed. @containers/packit-build please check.

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