Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (53 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

69 lines (53 loc) · 1.89 KB
Raw

Contributing

Thanks for contributing to Kubernetes Skill (KubeShark).

Goal of this repo

Improve Kubernetes manifest 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

# 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/insecure-workload-defaults.md',
  'references/resource-starvation.md',
  'references/network-exposure.md',
  'references/privilege-sprawl.md',
  'references/fragile-rollouts.md',
  'references/api-drift.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 cloud-provider-specific deep dives unless they directly reduce a known LLM failure mode.
  • Keep claims precise; avoid vague "always" language when tradeoffs exist.
  • Default to the Pod Security Standards restricted profile in all examples.

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 cluster state or kubeconfig data
  • do not include real IP addresses, hostnames, or cloud account identifiers

Community

Open an issue with:

  • observed hallucination/failure pattern
  • minimal reproducible prompt/context
  • expected behavior