Skip to content

Contributing Guide ​

Preparation ​

  1. Fork and clone the repository
  2. Create a feature branch from main
  3. Install project dependencies

Development Workflow ​

  1. Follow the corresponding coding standards (see language-specific standards in this category)
  2. Follow Git commit conventions (see Git Commit Conventions)
  3. Follow naming conventions (see Naming Conventions)
  4. Write code with readability in mind; avoid excessive abstraction
  5. New features must include tests

Submitting a PR ​

  1. Ensure all CI checks pass
  2. PR title follows the Conventional Commits format
  3. PR description includes: changes, reason for changes, testing method
  4. Keep PRs as small as possible (no more than 400 lines of change)
  5. Request at least 1 reviewer

Code Review ​

  • Review focuses on: logical correctness, security, performance, code style, maintainability
  • Discuss constructively; critique the code, not the person
  • After approval, merge with Squash Merge

Issue Guidelines ​

  • For bug reports, please provide: environment info, reproduction steps, expected behavior, actual behavior, screenshots
  • For feature requests, please describe: use case, desired effect
  • Use issue templates when available