Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (29 loc) · 1.07 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 1.07 KB
Raw

Contributing

Thanks for helping Socks become more useful.

What belongs here

Good contributions are practical, calm, and specific. Prefer advice that helps people make better decisions without shaming them for what they did not already know.

Helpful additions include:

  • New guides or checklists.
  • Corrections to unclear safety advice.
  • Better examples for common scams or pressure tactics.
  • Accessibility and readability improvements.
  • Tool notes that explain tradeoffs, not just recommendations.

Local setup

npm install
npm run dev

The site runs at http://127.0.0.1:4321. The visual editor runs at http://127.0.0.1:4321/keystatic.

Content style

  • Use plain language.
  • Avoid fear as the main motivator.
  • Explain the reason behind a recommendation.
  • Include safer defaults and recovery steps.
  • Name tradeoffs when recommending a tool.
  • Do not present legal, financial, or medical advice as professional counsel.

Before opening a pull request

npm run check
npm run build

If a command fails, include the failure in your pull request notes.