Merged
Conversation
Also update README.md with additional documentation around business logic
michael-riddle
previously approved these changes
Mar 12, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds agent-facing and user-facing documentation to clarify how the compliance_engine gem models and resolves compliance profile data, plus ignores common AI-assistant config files in git.
Changes:
- Add
AGENTS.mdwith repository architecture notes and common dev/test commands for AI agents. - Expand
README.mdwith “Concepts” documentation describing the data model, profile→Hiera resolution, confinement, and enforcement tolerance. - Update
.gitignoreto exclude various AI coding assistant configuration files/directories.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| README.md | Adds conceptual/business-logic documentation for how profiles map to checks and Hiera output. |
| AGENTS.md | Introduces AI-agent guidance including commands and architecture/business-logic notes. |
| .gitignore | Ignores common AI assistant configuration files to keep repo clean. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
jaevans
previously approved these changes
Mar 12, 2026
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
jaevans
approved these changes
Mar 12, 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.
Also update README.md with additional documentation around business logic