Skip to main content

Contributing

Thank you for your interest in the OpenTree project!

Development Environment​

# Clone the repository
git clone https://github.com/chaosys123/opentree.git
cd opentree

# Install dependencies
npm install

# Start dev server
npm run dev

Branch Strategy​

  • main - Stable release branch
  • dev - Development branch
  • feature/* - Feature branches
  • fix/* - Fix branches
  • docs/* - Documentation branches

Commit Convention​

Uses Conventional Commits:

feat: add music module search feature
fix: fix keychain list not refreshing after edit
docs: add deployment guide
refactor: refactor favorites data loading logic
chore: upgrade dependencies

Pull Request Process​

  1. Fork the repository
  2. Create branch git checkout -b feature/your-feature
  3. Write code, ensure tests pass
  4. Submit PR, describe changes clearly
  5. Wait for review

Code Style​

  • TypeScript strict mode
  • ESLint + Prettier
  • Function comments in English
  • Variable names in English

Feedback​