From 5b783caebf519f2e8082b38a38115388cb960046 Mon Sep 17 00:00:00 2001 From: Hira Barton Date: Fri, 8 Aug 2025 08:47:37 +0000 Subject: [PATCH] Add contributing.md --- contributing.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 contributing.md diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..fef8af2 --- /dev/null +++ b/contributing.md @@ -0,0 +1,27 @@ +# 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: "` +4. Open a PR with a quick rationale. + +## Credit +Contributors are legends. Add yourself to the PR; we’ll keep the list tidy.