ghost/contributing.md

914 B
Raw Blame History

Contributing to cipherstorm

Short version: keep it useful, keep it tidy, keep it classy (ish).

What to add

  • Resources (books, papers, labs, writeups) → add to README.md
  • Tools (frameworks, utilities, wordlists) → add to tools.md
  • Prefer official sources. Use 📖 for free / 📕 for paid.
  • Alphabetize within each section. One-line, factual descriptions.

What not to add

  • Dead links, paywalled mirrors, shady re-hosts.
  • Duplicates or personal promo dumps.

Style

  • Sentence case, end with a period.
  • No hype, no filler. (“Solid intro to X,” not “ultimate best most insane.”)
  • Keep the NoirStack tone: dry, pointed, helpful.

How to submit

  1. Branch from main.
  2. Edit the right file(s).
  3. git commit -m "Add: <name> — <one-liner>"
  4. Open a PR with a quick rationale.

Credit

Contributors are legends. Add yourself to the PR; well keep the list tidy.