-
Notifications
You must be signed in to change notification settings - Fork 206
Create AGENTS.md
#439
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
gjenkins8
wants to merge
1
commit into
helm:main
Choose a base branch
from
gjenkins8:gjenkins/agents.md
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Create AGENTS.md
#439
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,3 @@ | ||
| .idea | ||
| .idea | ||
| CLAUDE.md | ||
| .claude/ |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # AGENTS.md | ||
|
|
||
| This file provides guidance to agents when working with code in this repository. | ||
|
|
||
| ## Repository Purpose | ||
|
|
||
| This is the **Helm community** repository — it contains governance documents, Helm Improvement Proposals (HIPs), security policies, and project operations documentation for the Helm project generally. | ||
| It is **not** the Helm source code (do not suggest source code changes here). Content from this repo is imported into the Helm website for end-user consumption (helm.sh) via the `helm/helm-www` repository's `download-remote-community` command. | ||
|
|
||
| There is no build system, test suite, or CI pipeline for this repo. All content is Markdown and YAML. | ||
|
|
||
| ## Contributing | ||
|
|
||
| All commits must be signed off (DCO). Content is licensed under Creative Commons Attribution 4.0. Each PR needs 2 approvals from maintainers (org maintainers for process HIPs, project maintainers for feature/informational HIPs). | ||
|
|
||
| ## HIPs (Helm Improvement Proposals) | ||
|
|
||
| HIPs live in `hips/hip-NNNN.md`. The canonical format is defined in `hips/hip-0001.md`. | ||
|
|
||
| Use the `hip-author` skill (`.agents/skills/hip-author/`) for guided HIP creation — it walks through idea refinement, scope narrowing, and section-by-section drafting with the correct template and length targets. | ||
|
|
||
| ### Quick reference | ||
|
|
||
| - Preamble: YAML frontmatter with `hip`, `title`, `authors`, `created`, `type`, `status` (see `hip-0001.md` for full schema) | ||
| - Placeholder number: always use `hip: 9999` on initial submission | ||
| - Status: always `draft` on initial submission | ||
| - Types: `feature`, `informational`, `process` | ||
| - Required sections: Abstract, Motivation, Rationale, Specification, Backwards compatibility, Security implications, How to teach this, Reference implementation, Rejected ideas, Open issues, References | ||
| - Auxiliary files: `proposal-XXX-YY.ext` naming convention | ||
| - Update `hips/README.md` when adding a new HIP | ||
|
|
||
| ## Key Files | ||
|
|
||
| - `governance/governance.md` — full governance rules (maintainer structure, voting, decision-making) | ||
| - `SECURITY.md` — vulnerability reporting process and security team membership | ||
| - `maintainer-groups.yaml` — structured data of all maintainer groups, their repos, and mailing lists | ||
| - `MAINTAINERS.md` — current Helm org maintainers | ||
|
|
||
| ## Helm source | ||
|
|
||
| The main Helm source code lives in the [helm/helm](https://github.com/helm/helm) Github repository. Along-side additional Helm project repositories in the Helm github org: <https://github.com/helm>. | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This depends on #438 being merged (it could be removed, if we wanted to merge this first)