🤝 Contributing
Thanks for your interest in contributing! Here's how to get started.
Reporting Issues
- Search GitHub Issues for existing reports
- Create a new Issue with detailed description and reproduction steps
Submitting Code
- Fork the repository
bash
git clone https://github.com/your-username/my-docs.git
cd my-docs- Create a branch
bash
git checkout -b feature/your-feature- Install and develop
bash
npm install
npm run docs:dev- Commit and push
bash
git add .
git commit -m "feat: your changes"
git push origin feature/your-feature- Create a Pull Request on GitHub
Writing Guidelines
- Use Markdown for documentation
- Use Emoji sparingly for readability
- Specify language in code blocks
- Use
::: tip/::: warningcallouts - Place images in
docs/public/
Commit Convention
| Type | Description |
|---|---|
feat | New feature |
fix | Bug fix |
docs | Documentation change |
style | Code format (no functional change) |
refactor | Refactoring |
chore | Build/tooling change |
Adding New Pages
- Create
.mdfile in the appropriate directory - Register in
config.tssidebar - Write content
docs/
├── guide/ # Guide (Chinese)
├── dev/ # Dev docs (Chinese)
└── en/
├── guide/ # Guide (English)
└── dev/ # Dev docs (English)