Contributing Guide
Preparation
- Fork and clone the repository
- Create a feature branch from main
- Install project dependencies
Development Workflow
- Follow the corresponding coding standards (see language-specific standards in this category)
- Follow Git commit conventions (see Git Commit Conventions)
- Follow naming conventions (see Naming Conventions)
- Write code with readability in mind; avoid excessive abstraction
- New features must include tests
Submitting a PR
- Ensure all CI checks pass
- PR title follows the Conventional Commits format
- PR description includes: changes, reason for changes, testing method
- Keep PRs as small as possible (no more than 400 lines of change)
- 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