Skip to content

🤝 Contributing

Thanks for your interest in contributing! Here's how to get started.

Reporting Issues

  1. Search GitHub Issues for existing reports
  2. Create a new Issue with detailed description and reproduction steps

Submitting Code

  1. Fork the repository
bash
git clone https://github.com/your-username/my-docs.git
cd my-docs
  1. Create a branch
bash
git checkout -b feature/your-feature
  1. Install and develop
bash
npm install
npm run docs:dev
  1. Commit and push
bash
git add .
git commit -m "feat: your changes"
git push origin feature/your-feature
  1. Create a Pull Request on GitHub

Writing Guidelines

  • Use Markdown for documentation
  • Use Emoji sparingly for readability
  • Specify language in code blocks
  • Use ::: tip / ::: warning callouts
  • Place images in docs/public/

Commit Convention

TypeDescription
featNew feature
fixBug fix
docsDocumentation change
styleCode format (no functional change)
refactorRefactoring
choreBuild/tooling change

Adding New Pages

  1. Create .md file in the appropriate directory
  2. Register in config.ts sidebar
  3. Write content
docs/
├── guide/          # Guide (Chinese)
├── dev/            # Dev docs (Chinese)
└── en/
    ├── guide/      # Guide (English)
    └── dev/        # Dev docs (English)
最近更新

基于 VitePress + Teek 主题构建