Skip to content

Commit a2f079b

Browse files
committed
Add cursor rules
1 parent aab4476 commit a2f079b

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

.cursorrules

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Cursor Rules for S3Proxy Helm Chart Project
2+
3+
## Project Structure
4+
This is a Helm chart project for deploying S3Proxy to Kubernetes. The chart is located in `charts/s3proxy/`.
5+
6+
## Important File Handling Rules
7+
8+
### README.md Files - DO NOT EDIT DIRECTLY
9+
**CRITICAL:** The following README.md files are auto-generated and must NEVER be edited directly:
10+
- `/README.md` (root project README)
11+
- `/charts/s3proxy/README.md` (chart README, if it exists)
12+
13+
These files are generated from their corresponding template files using helm-docs.
14+
15+
**When asked to modify README content, you MUST:**
16+
1. ONLY edit the template file: `charts/s3proxy/README.md.gotmpl`
17+
2. NEVER directly edit any `README.md` files
18+
3. Inform the user that README.md is auto-generated and changes should be made to the template
19+
4. After editing the template, remind the user to regenerate README.md using helm-docs
20+
21+
**Template file location:**
22+
- Template: `charts/s3proxy/README.md.gotmpl`
23+
- Generated: `README.md` (root) - auto-generated from the template
24+
25+
## Helm Chart Best Practices
26+
- Always validate YAML syntax when editing chart files
27+
- Preserve the existing indentation style (spaces for YAML files as per YAML spec)
28+
- When modifying values.yaml, ensure documentation comments are kept in sync
29+
- Test template rendering with `helm template` after making changes

0 commit comments

Comments
 (0)