Thank you for considering contributing to useFlow! We welcome contributions from the community.
- Bun v1.2.23 or higher
- Node.js v18 or higher
-
Fork the repository
-
Clone your fork:
git clone https://github.com/YOUR_USERNAME/useflow.git cd useflow -
Install dependencies:
bun install
-
Build packages:
bun run build
-
Run tests:
bun test
useFlow/
├── packages/
│ ├── core/ # Framework-agnostic flow logic
│ └── react/ # React hooks and components
├── apps/
│ └── docs/ # Documentation site
└── examples/
└── react-examples/ # Example implementations
# Run all tests
bun test
# Watch mode
bun test:watch
# With coverage
bun test:coverage
# UI mode
bun test:uibun run typecheckbun run checkcd examples/react-examples
bun devbun run build:docs
cd apps/docs
bun dev-
Create a new branch for your feature/fix:
git checkout -b feature/your-feature-name
-
Make your changes and ensure:
- Tests pass:
bun test - Types are valid:
bun run typecheck - Code is formatted:
bun run check
- Tests pass:
-
Write tests for your changes when applicable
-
Commit your changes using conventional commits:
git commit -m "feat: add new feature"Commit message format:
feat:- New featurefix:- Bug fixdocs:- Documentation changeschore:- Maintenance taskstest:- Test changesrefactor:- Code refactoring
-
Push to your fork:
git push origin feature/your-feature-name
-
Create a Pull Request from your fork to the main repository
- Keep PRs focused on a single feature or fix
- Include tests for new functionality
- Update documentation if needed
- Ensure all tests pass and types are valid
- Follow the existing code style
- Reference any related issues in the PR description
- Use the issue tracker
- Check if the issue already exists before creating a new one
- Provide a clear description and reproduction steps
- Include relevant code examples and error messages
Feel free to open an issue for questions or discussions about contributing.
By contributing to useFlow, you agree that your contributions will be licensed under the MIT License.