Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
118 lines (82 loc) · 4.2 KB

CONTRIBUTING.md

File metadata and controls

118 lines (82 loc) · 4.2 KB
Raw

Contributing to Secure-by-Design Handbook

Thank you for your interest in contributing to the Secure-by-Design Handbook! This project aims to translate complex cyber-resilience regulations into practical, actionable guidance for connected device manufacturers.

🎯 Our Mission

We're building an authoritative, vendor-neutral reference that helps organizations implement security-by-design practices to comply with regulations like the EU Cyber-Resilience Act, NIS 2 Directive, ETSI EN 303 645, and IEC 62443.

🤝 How to Contribute

Content Contributions

We welcome contributions in several areas:

  • Standards Breakdowns: Plain-English explanations of regulatory requirements
  • Implementation Playbooks: Step-by-step technical guides (secure boot, SBOM, OTA, etc.)
  • Templates & Checklists: Evidence-ready artifacts and gap-analysis tools
  • Case Studies: Real-world implementation examples (anonymized)
  • Tool Reviews: Vendor-neutral evaluations of security tooling

Types of Contributions

  • 📝 Documentation: New guides, updates to existing content
  • 🐛 Bug Reports: Broken links, outdated information, technical errors
  • 💡 Suggestions: New topics, structural improvements
  • 🔧 Technical: Website improvements, accessibility fixes
  • 📊 Templates: Compliance checklists, reference architectures

📋 Content Guidelines

Please review our Style Guide before contributing. Key principles:

  • Authoritative: Cite standards precisely with clause numbers
  • Practical: Include actionable steps, code samples, templates
  • Vendor-neutral: Mention multiple solutions, disclose any affiliations
  • Accessible: Plain language, define acronyms, WCAG AA compliance

🚀 Getting Started

For Content Contributors

  1. Fork this repository
  2. Review existing content to avoid duplication
  3. Create a new branch for your contribution
  4. Write your content following our style guide
  5. Test locally with npm start
  6. Submit a pull request with a clear description

For Technical Contributors

  1. Check our Issues for open tasks
  2. Follow the same fork → branch → PR workflow
  3. Include tests for any functionality changes
  4. Ensure accessibility compliance

📝 Content Structure

New Standard/Regulation

docs/standards/
├── standard-name-overview.md
├── standard-name-requirements.md
└── standard-name-implementation.md

New Playbook

docs/playbooks/
└── topic-name/
    ├── overview.md
    ├── implementation.md
    └── examples/

✅ Submission Checklist

  • Content follows our style guide
  • All links are working
  • Code samples are tested
  • Sensitive information is redacted
  • Proper attribution for any referenced material
  • Clear, descriptive commit messages
  • PR description explains the contribution

🔍 Review Process

  1. Automated checks: Link validation, style checks
  2. Technical review: Accuracy of implementation guidance
  3. Compliance review: Regulatory interpretation correctness
  4. Editorial review: Style, clarity, accessibility
  5. Merge & deploy: Automatic deployment to live site

📞 Getting Help

🙋‍♀️ Contributor Recognition

Contributors are acknowledged in:

  • Individual page credits (for substantial contributions)
  • Project README contributor list
  • Annual contributor highlights

📜 License

By contributing, you agree that your contributions will be licensed under the same CC BY-SA 4.0 license that covers the project.

🛡️ Code of Conduct

We are committed to providing a welcoming and inclusive environment. Please be respectful in all interactions and focus on constructive collaboration.

Questions? Don't hesitate to open a discussion or reach out to the maintainers. We appreciate your interest in making connected devices more secure! 🔒