Skip to content

Commit 4f2133f

Browse files
committed
Create AGENTS.md
Signed-off-by: George Jenkins <gvjenkins@gmail.com>
1 parent 82cca09 commit 4f2133f

2 files changed

Lines changed: 39 additions & 1 deletion

File tree

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
.idea
1+
.idea
2+
CLAUDE.md
3+
.claude/

AGENTS.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4+
5+
## Repository Purpose
6+
7+
This is the **Helm community** repository — it contains governance documents, Helm Improvement Proposals (HIPs), security policies, and project operations documentation. It is **not** the Helm source code. Content from this repo is imported into the Helm website (helm.sh) via the `helm/helm-www` repository's `download-remote-community` command.
8+
9+
There is no build system, test suite, or CI pipeline for this repo. All content is Markdown and YAML.
10+
11+
## Contributing
12+
13+
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).
14+
15+
## HIPs (Helm Improvement Proposals)
16+
17+
HIPs live in `hips/hip-NNNN.md`. The canonical format is defined in `hips/hip-0001.md`.
18+
19+
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.
20+
21+
### Quick reference
22+
23+
- Preamble: YAML frontmatter with `hip`, `title`, `authors`, `created`, `type`, `status` (see `hip-0001.md` for full schema)
24+
- Placeholder number: always use `hip: 9999` on initial submission
25+
- Status: always `draft` on initial submission
26+
- Types: `feature`, `informational`, `process`
27+
- Required sections: Abstract, Motivation, Rationale, Specification, Backwards compatibility, Security implications, How to teach this, Reference implementation, Rejected ideas, Open issues, References
28+
- Auxiliary files: `proposal-XXX-YY.ext` naming convention
29+
- Update `hips/README.md` when adding a new HIP
30+
31+
## Key Files
32+
33+
- `governance/governance.md` — full governance rules (maintainer structure, voting, decision-making)
34+
- `SECURITY.md` — vulnerability reporting process and security team membership
35+
- `maintainer-groups.yaml` — structured data of all maintainer groups, their repos, and mailing lists
36+
- `MAINTAINERS.md` — current Helm org maintainers

0 commit comments

Comments
 (0)