Thank you for your interest in contributing to RsTree! This document provides guidelines and information for contributors.
- Clone the repository
- Install dependencies:
pnpm install - Start the example app:
pnpm dev - Run tests:
pnpm test
packages/ui/- Main component librarypackages/example/- Example application and playgroundpackages/ui/src/Tree/- Tree component implementationpackages/ui/src/test/- Test files
- Create a feature branch from
main - Make your changes
- Add tests for new functionality
- Ensure all tests pass:
pnpm test - Run linting:
pnpm lint - Submit a pull request
- Use TypeScript for all new code
- Follow ESLint configuration
- Write meaningful commit messages
- Include JSDoc comments for public APIs
- Write unit tests for components
- Test edge cases and accessibility
- Ensure good test coverage
- Use React Testing Library for component tests
- Provide a clear description of changes
- Include screenshots for UI changes
- Reference related issues
- Ensure CI checks pass
Feel free to open an issue for any questions about contributing.