Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 1.26 KB

File metadata and controls

51 lines (36 loc) · 1.26 KB

Contributing to RsTree

Thank you for your interest in contributing to RsTree! This document provides guidelines and information for contributors.

Development Setup

  1. Clone the repository
  2. Install dependencies: pnpm install
  3. Start the example app: pnpm dev
  4. Run tests: pnpm test

Project Structure

  • packages/ui/ - Main component library
  • packages/example/ - Example application and playground
  • packages/ui/src/Tree/ - Tree component implementation
  • packages/ui/src/test/ - Test files

Development Workflow

  1. Create a feature branch from main
  2. Make your changes
  3. Add tests for new functionality
  4. Ensure all tests pass: pnpm test
  5. Run linting: pnpm lint
  6. Submit a pull request

Code Style

  • Use TypeScript for all new code
  • Follow ESLint configuration
  • Write meaningful commit messages
  • Include JSDoc comments for public APIs

Testing

  • Write unit tests for components
  • Test edge cases and accessibility
  • Ensure good test coverage
  • Use React Testing Library for component tests

Pull Request Guidelines

  • Provide a clear description of changes
  • Include screenshots for UI changes
  • Reference related issues
  • Ensure CI checks pass

Questions?

Feel free to open an issue for any questions about contributing.