VitePress

简体中文

English

简体中文

English

主题

贡献指南 ​

感谢您对 VitePress开发指南的关注！我们欢迎各种形式的贡献，无论是代码、文档、设计还是想法建议。

🤝 贡献方式 ​

代码贡献 ​

  • Bug 修复 - 修复已知问题和错误
  • 新功能开发 - 添加新的功能特性
  • 性能优化 - 提升网站性能和用户体验
  • 代码重构 - 改进代码结构和可维护性

文档贡献 ​

  • 内容改进 - 完善现有文档内容
  • 新增教程 - 编写新的技术教程
  • 翻译工作 - 协助多语言文档翻译
  • 错误修正 - 修复文档中的错误和遗漏

设计贡献 ​

  • UI/UX 改进 - 优化用户界面和体验
  • 视觉设计 - 改进网站视觉效果
  • 图标设计 - 设计和优化图标资源
  • 品牌设计 - 完善品牌视觉识别

社区贡献 ​

  • 问题解答 - 帮助其他用户解决问题
  • 经验分享 - 分享使用经验和最佳实践
  • 活动组织 - 组织技术交流活动
  • 推广宣传 - 帮助推广项目和社区

🚀 快速开始 ​

1. 准备环境 ​

bash
# 克隆项目
git clone https://github.com/mmwk/mmwk.cn.git
cd mmwk.cn

# 安装依赖
npm install

# 启动开发服务器
npm run dev

2. 创建分支 ​

bash
# 创建新分支
git checkout -b feature/your-feature-name

# 或者修复 bug
git checkout -b fix/your-bug-fix

3. 进行开发 ​

bash
# 进行您的修改
# 编辑文件...

# 测试修改
npm run build
npm run preview

4. 提交更改 ​

bash
# 添加修改的文件
git add .

# 提交修改（遵循提交规范）
git commit -m "feat: add new tutorial for VitePress"

# 推送到远程分支
git push origin feature/your-feature-name

5. 创建 Pull Request ​

  1. 访问 GitHub 仓库
  2. 点击 "New Pull Request"
  3. 选择您的分支
  4. 填写 PR 描述
  5. 提交 Pull Request

📝 贡献规范 ​

代码规范 ​

JavaScript/TypeScript ​

javascript
// 使用 ESLint 和 Prettier 格式化代码
// 遵循 Vue.js 官方风格指南

// 好的示例
const getUserInfo = async (userId) => {
  try {
    const response = await api.getUser(userId)
    return response.data
  } catch (error) {
    console.error('Failed to fetch user:', error)
    throw error
  }
}

CSS/SCSS ​

css
/* 使用 BEM 命名规范 */
.tutorial-card {
  padding: 1rem;
  border-radius: 8px;
}

.tutorial-card__title {
  font-size: 1.25rem;
  font-weight: 600;
}

.tutorial-card--featured {
  border: 2px solid var(--color-primary);
}

Vue 组件 ​

vue
<template>
  <div class="component-name">
    <h2>{{ title }}</h2>
    <slot />
  </div>
</template>

<script setup lang="ts">
interface Props {
  title: string
}

defineProps<Props>()
</script>

<style scoped>
.component-name {
  /* 组件样式 */
}
</style>

文档规范 ​

Markdown 格式 ​

markdown
---
title: "文档标题"
description: "文档描述"
head:
  - - meta
    - name: keywords
      content: "关键词1,关键词2,关键词3"
outline: deep
lastUpdated: true
---

# 文档标题

文档内容...

## 二级标题

### 三级标题

- 列表项 1
- 列表项 2

```javascript
// 代码示例
const example = 'Hello World'
```

内容要求 ​

  • 准确性 - 确保内容准确无误
  • 完整性 - 提供完整的信息和示例
  • 清晰性 - 使用清晰易懂的语言
  • 实用性 - 提供实际可用的代码示例

提交规范 ​

提交信息格式 ​

<type>(<scope>): <subject>

<body>

<footer>

类型说明 ​

  • feat - 新功能
  • fix - Bug 修复
  • docs - 文档更新
  • style - 代码格式调整
  • refactor - 代码重构
  • test - 测试相关
  • chore - 构建过程或辅助工具的变动

示例 ​

bash
feat(tutorials): add TypeScript advanced tutorial

- Add comprehensive TypeScript tutorial
- Include practical examples and exercises
- Update navigation and index pages

Closes #123

🔍 代码审查 ​

审查流程 ​

  1. 自动检查 - CI/CD 自动运行测试和检查
  2. 人工审查 - 维护者进行代码审查
  3. 反馈修改 - 根据反馈进行必要修改
  4. 合并代码 - 审查通过后合并到主分支

审查标准 ​

  • 功能正确性 - 功能是否按预期工作
  • 代码质量 - 代码是否清晰、可维护
  • 性能影响 - 是否对性能产生负面影响
  • 兼容性 - 是否保持向后兼容
  • 测试覆盖 - 是否包含必要的测试

🐛 问题报告 ​

Bug 报告模板 ​

markdown
## Bug 描述
简要描述遇到的问题

## 复现步骤
1. 访问页面 xxx
2. 点击按钮 xxx
3. 观察到错误 xxx

## 预期行为
描述您期望发生的情况

## 实际行为
描述实际发生的情况

## 环境信息
- 操作系统: [例如 macOS 12.0]
- 浏览器: [例如 Chrome 95.0]
- Node.js 版本: [例如 16.14.0]

## 附加信息
提供任何其他相关信息、截图或日志

功能请求模板 ​

markdown
## 功能描述
简要描述您希望添加的功能

## 使用场景
描述这个功能的使用场景和价值

## 详细设计
如果有具体的设计想法，请详细描述

## 替代方案
是否考虑过其他替代方案

## 附加信息
提供任何其他相关信息或参考资料

🎯 贡献领域 ​

技术文档 ​

  • VitePress 教程 - 深入的使用指南
  • Vue.js 教程 - 框架学习资料
  • 前端最佳实践 - 开发经验分享
  • 工具使用指南 - 开发工具介绍

示例项目 ​

  • 完整项目案例 - 实际应用示例
  • 代码片段 - 可复用的代码示例
  • 配置模板 - 常用配置文件
  • 部署脚本 - 自动化部署方案

工具和插件 ​

  • VitePress 插件 - 扩展功能插件
  • 开发工具 - 提升开发效率的工具
  • 构建脚本 - 自动化构建工具
  • 测试工具 - 质量保证工具

🏆 贡献者权益 ​

认可和奖励 ​

  • 贡献者列表 - 在项目中展示贡献者
  • 特殊徽章 - GitHub 个人资料徽章
  • 社区声誉 - 在社区中获得认可
  • 技能提升 - 通过贡献提升技术能力

学习机会 ​

  • 代码审查 - 学习最佳实践
  • 技术交流 - 与专家交流学习
  • 项目经验 - 获得开源项目经验
  • 网络建设 - 扩展技术人脉

职业发展 ​

  • 简历加分 - 开源贡献经历
  • 技能证明 - 实际项目经验
  • 行业认知 - 提升行业影响力
  • 就业机会 - 获得更多就业机会

📞 联系我们 ​

技术讨论 ​

社区交流 ​

  • QQ 群 - 123456789 (VitePress 中文交流群)
  • 微信群 - 添加管理员微信：mmwk-admin
  • 邮箱 - contribute@mmwk.cn

商务合作 ​

🌟 致谢 ​

感谢所有为项目做出贡献的开发者、设计师、文档作者和社区成员。正是因为大家的努力，VitePress开发指南才能不断发展壮大。

核心贡献者 ​

特别感谢 ​

  • Vue.js 团队 - 提供优秀的框架和工具
  • VitePress 团队 - 开发出色的文档生成工具
  • 开源社区 - 提供丰富的学习资源和支持

📋 行为准则 ​

我们的承诺 ​

为了营造一个开放和友好的环境，我们承诺让每个人都能在我们的项目和社区中获得良好的体验，无论其年龄、体型、残疾、种族、性别认同和表达、经验水平、国籍、个人形象、种族、宗教或性取向如何。

我们的标准 ​

有助于创造积极环境的行为包括：

  • 使用友好和包容的语言
  • 尊重不同的观点和经验
  • 优雅地接受建设性批评
  • 关注对社区最有利的事情
  • 对其他社区成员表示同情

执行 ​

如果您遇到任何不当行为，请联系项目维护者。我们将认真对待所有投诉，并进行适当的调查和回应。

再次感谢您对 VitePress开发指南的关注和支持！我们期待您的贡献，让我们一起构建更好的技术文档生态系统。

立即开始您的贡献之旅！ 🚀

vitepress开发指南

Copyright © 2025 mmwk.cn