Create a Pull Request
Learn how to contribute your changes back to the project through a well-crafted pull request.
Getting Started
Prerequisites
1. Fork the project repository
2. Clone your fork locally
3. Setup with npx setup:project
Your First PR
- 1. Create a feature branch
- 2. Make your changes (code, docs, tests)
- 3. Submit a draft pull request
Contribution Workflow
1 Create Feature Branch
$ git checkout -b feature/my-changes
2 Make Changes
Implement your feature, fix bug, or enhance documentation
• Write new tests, if applicable
• Update documentation in the appropriate sections
3 Test Your Changes
$ npm run test $ npm run lint
4 Commit Changes
Use semantic commits (conventional commits)
$ git commit -m "feat: added new component"
See convention guide.
5 Push Branch
$ git push origin feature/my-changes
6 Create PR
Go to GitHub and create a PR from your branch to upstream/main
Include:
- • Clear title and description
- • Reference any related issues
- • Mention if this needs testing
Best Practices
Atomic Commits
Break changes into small, logical commits with clear messages.
Documentation
Update documentation to match changes (add tests, code comments, user guides).
Testing
Include test coverage for all new features and ensure existing tests pass.
Responsiveness
Be ready to address feedback promptly for faster review and merge.
Ready to Submit?
When your PR is ready, submit it and we'll review it as quickly as possible. Join our Discord for real-time help.
Open on GitHub