Contribution Style Guide

Create beautiful, maintainable code and documentation by following these community standards

  • • Use Prettier for auto-formatting (configuration available in .prettierrc)
  • • Adopt ESLint with standard-react configuration
  • • Use 2 spaces for indentation
  • • Type declarations must be included in all public functions
  • • Add JSDoc comments for all exported functions

// Good
interface User {
  id: string;
  email: string;
  preferences?: string;
}

// Bad
// Missing type annotations
function getUser() {
  ...
}
  • • Use Markdown with GitHub flavored syntax
  • • Follow the Markdown Style Guide
  • • Include TOC for files longer than 3 pages
  • • Add examples/ directory for code samples
  • • Use SVG for diagrams (see docs/assets/diagrams/)
  • • Feature branches follow semantic naming: feature/yourname/feature-name
  • • PRs require 2 approvals and passing CI tests
  • • Add Changelog entries for public-facing changes
  • • Use GitHub Issues for all work tracking
  • • Include before/after code comparisons in change notes

Need Help?

Join our contributor Discord server in Community for live support and collaboration.