Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (24 loc) · 952 Bytes

CONTRIBUTING.md

File metadata and controls

36 lines (24 loc) · 952 Bytes

Contributing to shielded-docs

Welcome! We're thrilled that you want to help improve the documentation of the Shielded Protocol.

Contributor Tracks

1. Documentation (Astro/Starlight)

  • Setup: Install Node.js.
  • Dev: npm install && npm run dev
  • Good issues: Look for layer:docs labels.

2. Technical Writing

  • Help us explain complex ZK concepts in plain English.
  • Good issues: Look for status:wave-ready and type:docs.

Your First PR

  1. Fork the repo.
  2. Create a branch: git checkout -b docs/clarify-merkle-tree.
  3. Make your changes and verify they look good in the dev server.
  4. Submit a PR!

PR Checklist

  • Content is accurate and clear
  • No broken links
  • Correct markdown/MDX syntax
  • Issue linked

Code of Conduct

We follow the Contributor Covenant. Be kind and professional.

Wave Contributors

Check out Wave-ready issues to earn points!