cfec11bb46
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
stop-slop, taste-skill, terrashark had embedded .git dirs causing Woodpecker clone to fail on submodule update.
67 lines
1.7 KiB
Markdown
67 lines
1.7 KiB
Markdown
# Contributing
|
|
|
|
Thanks for contributing to Terrashark.
|
|
|
|
## Goal of this repo
|
|
|
|
Improve Terraform/OpenTofu output quality while staying lean on token usage.
|
|
|
|
Every change should answer:
|
|
- which failure mode does this prevent?
|
|
- what measurable quality gain does it provide?
|
|
- is the token cost justified?
|
|
|
|
## Development flow
|
|
|
|
1. create a branch
|
|
2. make focused changes
|
|
3. run local checks
|
|
4. open PR using `.github/PULL_REQUEST_TEMPLATE.md`
|
|
|
|
## Local checks
|
|
|
|
```bash
|
|
# quick sanity checks
|
|
rg -n "FIXME|placeholder-text" README.md SKILL.md references/*.md
|
|
python - <<'PY'
|
|
from pathlib import Path
|
|
assert Path('SKILL.md').exists()
|
|
assert Path('README.md').exists()
|
|
for p in [
|
|
'references/identity-churn.md',
|
|
'references/secret-exposure.md',
|
|
'references/blast-radius.md',
|
|
'references/ci-drift.md',
|
|
'references/compliance-gates.md',
|
|
]:
|
|
assert Path(p).exists(), f'missing {p}'
|
|
print('basic structure OK')
|
|
PY
|
|
```
|
|
|
|
## Content rules
|
|
|
|
- Keep examples original and clearly distinct.
|
|
- Prefer failure-mode framing over generic "best-practice dump" text.
|
|
- Avoid provider-specific deep dives unless they directly reduce a known LLM failure mode.
|
|
- Keep claims precise; avoid vague "always" language when tradeoffs exist.
|
|
|
|
## Required for PR approval
|
|
|
|
- clear mapping to one or more failure modes
|
|
- no contradictory guidance across references
|
|
- updated links/indexes if files were moved/renamed
|
|
- validation workflow passing (`.github/workflows/validate.yml`)
|
|
|
|
## Security
|
|
|
|
- never commit credentials, tokens, or secret values
|
|
- do not paste real state snippets containing sensitive data
|
|
|
|
## Community
|
|
|
|
Open an issue with:
|
|
- observed hallucination/failure pattern
|
|
- minimal reproducible prompt/context
|
|
- expected behavior
|
|
|