Contribute

Everything on this site lives in a public repository. Content is CC BY 4.0 and code is MIT, so you can reuse it, and you can help improve it. Every suggested change is reviewed before it’s published, and Faraday has the final say on what goes live.

Ways to help

• Report an error. Every page has a “tell us” link at the bottom. Include what’s wrong and a source if you have one.
• Review a guide. We especially want privacy lawyers, practitioners, family violence advocates, security professionals and teachers to check the guides in their area. Open an issue saying which guide you’ve reviewed and what you found, even if the answer is “it’s right”.
• Translate. The help page and the people guides would do the most good in te reo Māori, Samoan, Tongan, Hindi and Chinese.
• Write. Propose a new guide or template by opening an issue first, so we can discuss scope and the dual-use review.
• Test the tools. Try to break them. Check the deadline calculator against your own calculations.

Standards

Before contributing, read CONTRIBUTING.md and GOVERNANCE.md. In short:

• Cite primary sources and add them to the source registry with the date you checked them.
• Write plain New Zealand English. The build runs a prose linter that rejects padded phrases and US spellings.
• Write from the defender’s side. We don’t publish techniques for finding or tracking a particular person.
• Say when something needs a professional.

Running it locally

You need Node.js 20 or later.

npm install
npm start        # local preview at http://localhost:8080
npm run check    # tests, prose lint, source check and build