Contributor Handbook

Everything you need to know to contribute effectively to this community-driven project. From code to documentation, find your perfect contribution path.

Getting Started

📦

Set Up Your Environment

  1. 1. Install dev-tools@latest
  2. 2. Fork and clone the repository
  3. 3. Run npx setup:project
Details →
📝

Choose a Contribution Type

  • Fix bugs in existing code
  • Write documentation
  • Test edge cases
  • Design UI/UX elements
Explore →

Contribution Standards

💻

Code Contributions

  • Follow Prettier and ESLint configurations
  • Write 100% test coverage for new features
  • Use semantic commit messages
  • Include changelog entries in PRs
📚

Documentation

  • Keep docs in Markdown with specific structure
  • Add examples to every guide section
  • Write for all skill levels
  • Include version-specific notes
🧪

Testing

  • Use Storybook for UI components
  • Write unit and integration tests
  • Test across all major browsers
  • Report all edge cases

Contribution Workflow

  1. 1

    Create a Feature Branch

    Use semantic naming: feature/add-component or fix/authentication-bug

  2. 2

    Write & Test Code

    Run npm run test and npm run lint before committing

  3. 3

    Submit a Draft PR

    Include all context in the PR description and request a maintainer for review

Community Guidelines

🤝

Code of Conduct

  • Be respectful and inclusive in all interactions
  • Use plain-language explanations
  • Actively listen to feedback
  • Maintain a patient and encouraging tone
💬

Communication Practices

  • Use GitHub issues for code discussions
  • Discord for real-time questions
  • Email for formal contributor agreements
  • Slack for emergency outages

Next Steps

🎯

Find an Issue

Browse GitHub for good-first-issue or help-wanted labels

🚀

Submit a Contribution

Once ready, follow our contribution workflow