Skip to content

add AGENTS.md and a basic readme for the SDK#162

Merged
kcp-ci-bot merged 1 commit intokcp-dev:mainfrom
xrstf:add-agents-md
Apr 28, 2026
Merged

add AGENTS.md and a basic readme for the SDK#162
kcp-ci-bot merged 1 commit intokcp-dev:mainfrom
xrstf:add-agents-md

Conversation

@xrstf
Copy link
Copy Markdown
Contributor

@xrstf xrstf commented Apr 28, 2026

Summary

This is basically a carbon-copy of kcp-dev/kcp-operator#203:

I want to make sure folks do not blindly let AI agents update SDK dependencies, thinking they are doing the project a favor, when instead they often would just introduce a hassle for downstream consumers.

From what I understand, having a dedicated AGENTS.md in the sdk/ directory should accomplish that. However what I initially wrote as an AGENTS.md was, according to Claude, more of a README, which Claude also assured me would totally be respected by AI agents, too. 🤞 So I pivoted to having a nice README instead to make our human friends happy.

What Type of PR Is This?

/kind chore

Release Notes

NONE

@kcp-ci-bot kcp-ci-bot added release-note-none Denotes a PR that doesn't merit a release note. kind/chore Categorizes issue or PR as related to maintenance and other usually non-code changes. dco-signoff: yes Indicates the PR's author has signed the DCO. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Apr 28, 2026
@xrstf
add AGENTS.md and a basic readme for the SDK
6018809 
On-behalf-of: @SAP christoph.mewes@sap.com
ntnn
ntnn approved these changes Apr 28, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@ntnn ntnn left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@kcp-ci-bot kcp-ci-bot added the lgtm Indicates that a PR is ready to be merged. label Apr 28, 2026
@kcp-ci-bot
Copy link
Copy Markdown
Contributor

kcp-ci-bot commented Apr 28, 2026

LGTM label has been added.

DetailsGit tree hash: 720346c0145ec7a206c137ce601d60922f7a33e8

@xrstf
Copy link
Copy Markdown
Contributor Author

xrstf commented Apr 28, 2026

/approve

@kcp-ci-bot
Copy link
Copy Markdown
Contributor

kcp-ci-bot commented Apr 28, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ntnn, xrstf

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kcp-ci-bot kcp-ci-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 28, 2026
@ntnn ntnn added this to tbd Apr 28, 2026
@ntnn ntnn moved this to Reviewing in tbd Apr 28, 2026
@kcp-ci-bot kcp-ci-bot merged commit c384dce into kcp-dev:main Apr 28, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ntnn ntnn ntnn approved these changes

Assignees

@ntnn ntnn

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates the PR's author has signed the DCO. kind/chore Categorizes issue or PR as related to maintenance and other usually non-code changes. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@xrstf @kcp-ci-bot @ntnn