Add AGENTS.md AI-assistant configuration - #158
Merged
Merged
Conversation
Add an AGENTS.md describing the rsync module's business logic for AI coding assistants, along with the standard AI-assistant plumbing: - AGENTS.md analysis of the module - AI coding assistant .gitignore block (the standard is AGENTS.md; ignore tool-specific files like /CLAUDE.md, /.claude/, etc.) - /AGENTS.md added to .pdkignore so it is excluded from Forge builds Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds repository-level AI-assistant documentation/configuration for this Puppet module, primarily by introducing an AGENTS.md that documents the module’s public API, internal classes, and operational “gotchas”, and by ensuring that file is excluded from Forge builds.
Changes:
- Added a comprehensive
AGENTS.mddescribing module business logic, entry points, dependencies, and common dev/test commands. - Updated
.pdkignoreto exclude/AGENTS.mdfrom Forge packaging/builds. - Updated
.gitignoreto ignore tool-specific AI assistant config files (e.g., Claude/Cursor/Windsurf/Gemini/Cline/Copilot instruction files).
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| AGENTS.md | Adds AI-agent-facing documentation of module behavior, interfaces, and workflows. |
| .pdkignore | Excludes AGENTS.md from PDK/Forge build artifacts. |
| .gitignore | Ignores AI-assistant tool configuration files not intended for commit. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
added 2 commits
July 9, 2026 13:44
Line numbers drift as code changes and were flagged brittle in review; retain durable anchors (file paths + class/define/type/function names) and remove the now-redundant line-reference disclaimer where present.
The `action` property accepts `push`/`pull` (default `pull`), not `pull`/`pull`. Also remove the stray `</content>`/`</invoke>` artifact at EOF.
michael-riddle
approved these changes
Jul 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation-only change: adds an AGENTS.md describing the rsync module's business logic for AI coding assistants, plus the standard AI-assistant plumbing (.gitignore block for tool-specific files, and
/AGENTS.mdin .pdkignore so it is excluded from Forge builds). No code or behavior changes.🤖 Generated with Claude Code