Contribution Guide
This guide walks through the complete contribution lifecycle from setup to pull request. Whether you're new to open source or a seasoned contributor, find your path below.
Getting Started
Prerequisites
1. Install dev-tools@latest
with npx
2. Fork the repository and clone locally
3. Run npx setup:project
for configuration
Your First Contribution
- โข Choose from these types of contributions:
- - Code improvements
- - Documentation
- - Testing/quality assurance
- - User experience design
Types of Contributions
Code
- Fix bugs reported in GitHub
- Add new features
- Optimize algorithms
- Improve test coverage
Documentation
- Improve documentation
- Write new tutorials
- Create API documentation
- Enhance visual guides
Quality Assurance
- Test edge cases
- Create test scenarios
- Write test scripts
- Monitor browser compatibility
Contribution Workflow
-
1
Create Feature Branch
Use semantic naming:
feature/add-component
orfix/authentication-bug
-
2
Write & Test Code
- Run
npm run test
- Run
npm run lint
- Maintain 100% test coverage
- Follow Prettier & ESLint
- Add changelog entries
- Use semantic commits
- Run
-
3
Submit Draft PR
Include: Clear description of changes, relevant documentation updates, and test results. Request review from a code owner.
-
4
Final Review & Merge
Once approved, maintainer will merge changes. Celebrate your contribution!
Community Guidelines
Code of Conduct
- โข Be welcoming to all participants
- โข Use inclusive language
- โข Listen respectfully to feedback
- โข Maintain constructive tone
Communication
- โข Use GitHub Issues for code
- โข Ask questions in Discord
- โข Email for formal agreements
- โข Use Slack for urgent issues
Ready to contribute?
Join thousands of contributors who have helped make this project what it is today. Your impact matters.
Report an Issue Start Contributing