docs(AGENTS.md): cross-reference remaining project README files#13035
Open
jsonmp-k8 wants to merge 1 commit intokubeflow:masterfrom
Open
docs(AGENTS.md): cross-reference remaining project README files#13035jsonmp-k8 wants to merge 1 commit intokubeflow:masterfrom
jsonmp-k8 wants to merge 1 commit intokubeflow:masterfrom
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds remaining internal documentation cross-references in AGENTS.md so contributors can quickly find the appropriate README/CONTRIBUTING guidance for common workflows (commit policy, protobuf regeneration, deployments, and testing).
Changes:
- Updates
AGENTS.md“Last updated” date. - Adds references to remaining repo READMEs/CONTRIBUTING docs in the most relevant sections (commit policy, deployment, testing, protobuf generation, and key paths).
Contributor
Author
|
/ok-to-test |
Add CLAUDE.md referencing AGENTS.md for Claude Code configuration. Cross-reference remaining README/CONTRIBUTING files in AGENTS.md. Signed-off-by: Jaison Paul <[email protected]>
a51de1d to
1ad36b7
Compare
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.
Summary
CONTRIBUTING.md(root) → Commit policy sectionapi/README.md→ Regenerate protobufs sectionbackend/api/README.md→ Regenerate protobufs sectionfrontend/README.md→ Key paths sectionkubernetes_platform/README.md→ Key paths sectionmanifests/kustomize/README.md→ Local cluster deployment sectiontest/README.md→ Local testing sectionTest plan