Adding AGENTS.md#4573
Open
CsatariGergely wants to merge 2 commits into
Open
Conversation
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5
CsatariGergely
requested review from
efiacor,
kispaljr,
liamfallon and
mozesl-nokia
as code owners
✅ Deploy Preview for kptdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
dosubot
Bot
added
size:L
This was
linked to
issues
Jun 4, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new AGENTS.md guide intended for AI/code agents working on the kpt repository, including repository context, contributor guidelines, and commonly used build/test/CI commands to reduce setup friction and encourage consistent workflows.
Changes:
- Introduces
AGENTS.mdwith generic rules for AI-assisted coding and PR reviews. - Documents key build/test targets (
make all,make test-docker, e2e targets) and environment variables. - Summarizes repository structure and CI workflows to help agents navigate the codebase.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+16
to
+17
| * When comitting suggested changes add a signoff of the approving human and add the `Assisted-by` | ||
| tag to the commit message |
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Assisted-by: GitHub Copilot: Claude Haiku 4.5 Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Comment on lines
+3
to
+4
| For Copilot, Cursor, Codex, Gemini Code Assist or any agents generating code or review Pull Requests | ||
| in this repository. |
Comment on lines
+16
to
+17
| * When comitting suggested changes add a signoff of the approving human and add the `Assisted-by` | ||
| tag to the commit message |
| * **.github/workflows/go.yml**: Main CI workflow | ||
| * Runs on Linux (docker/podman matrix) and macOS | ||
| * Executes: `make all` + `make test-docker` | ||
| * Triggered on PRs and pushes (excludes dependabot branches) |
Comment on lines
+253
to
+255
| * **KPT_NO_PAGER_HELP**: Set to 1 to disable pager for help output | ||
| PAGER: Custom pager command (default: less -R) | ||
| * **KPT_FN_WASM_RUNTIME**: WASM function runtime selection |
|
|
||
| * **Unit Tests**: Run with `make test` (standard Go tests) | ||
| * **Docker-based Tests**: Run with `make test-docker` (requires container runtime) | ||
| * **Function E2E Tests**: Run with make `test-fn-render` / `make test-fn-eval` (testdata-driven) |
|
|
||
| ## Implementation Notes for Code Changes | ||
|
|
||
| * **CLI Commands**: Add to `commands/` directory; use Cobra; update `documentation/cli` for documentation |
| ### Code Generation & Formatting | ||
|
|
||
| ```bash | ||
| make fmt # Run gofmt and goimports |
Comment on lines
+160
to
+161
| * Run `make serve` from root (serves docs locally) | ||
| * Requires `npm install` first |
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.
Adding AGENTS.md
The original AGENTS.md was generated by GitHub Copilot: Claude Haiku 4.5. I've made small edits here and there.