Update AGENTS.md to remove extra information#1101
Merged
Merged
Conversation
Removed copy-pasted infromation that is not relevant to this project. Simplified the review and code generation instructions. Added details about how pack/unpack works by changeing the directory. Signed-off-by: Gorkem Ercan <gorkem.ercan@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the repository’s agent/reviewer guidance by removing unrelated/copied content, streamlining instructions, and documenting KitOps-specific pack/unpack implementation pitfalls.
Changes:
- Simplified “Code Generation Instructions” and “Code Review Instructions” to focus on minimum-scope changes and evidence-based review.
- Added Go license header guidance and an
addlicensecommand for bulk fixes. - Added a “CWD Switching During Pack/Unpack” section documenting
os.Chdirbehavior across pack/unpack/import.
Comments suppressed due to low confidence (2)
AGENTS.md:72
- This bullet says artifacts must conform to the OCI and “ModelKit specification”, but the repo/docs clearly distinguish ModelKit vs ModelPack formats/specs. Consider updating this to explicitly reference both specs (or clarify which format/spec applies in which code path) to avoid misleading reviewers.
- **OCI spec compliance**: Layers, manifests, and media types must conform to the OCI and ModelKit specification.
AGENTS.md:32
- The license header example hard-codes
Copyright 2024, but the repo already contains Go files withCopyright 2025. Consider making the year a placeholder (or a range) in this snippet so new files don’t copy an incorrect year while still satisfying the required license text.
// Copyright 2024 The KitOps Authors.
//
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Humans will remove these markers as they review each file. PRs with remaining markers will be rejected by CI. | ||
|
|
||
| **What you MUST ignore:** | ||
| Humans will remove these markers as they review each file. PRs with remaining markers will be rejected by CI. |
There was a problem hiding this comment.
The doc claims PRs with remaining AGENT_MODIFIED markers will be rejected by CI, but there doesn’t appear to be any CI/workflow check in this repo that searches for AGENT_MODIFIED. Either add an explicit CI step (e.g., grep the diff/worktree for the marker) or adjust the wording so it doesn’t state CI enforcement that isn’t present.
Suggested change
| Humans will remove these markers as they review each file. PRs with remaining markers will be rejected by CI. | |
| Humans will remove these markers as they review each file. PRs with remaining markers must not be merged until all markers are removed. |
amisevsk
approved these changes
Mar 2, 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.
Removed copy-pasted infromation that is not relevant to this project. Simplified the review and code generation instructions. Added details about how pack/unpack works by changeing the directory.
AI-Assisted Code