跳到主要内容

参与贡献指南

感谢您对 HowToCookVegan 项目的关注!我们欢迎所有热爱素食、关注健康与地球的朋友参与贡献。

如何参与贡献?

1. 添加或改进食谱

你可以:

  • 添加你最喜欢的素食食谱
  • 改进现有食谱的步骤说明
  • 添加食谱的烹饪技巧和注意事项
  • 补充食谱的营养信息

贡献方式:

  • docs/recipes/ 目录下找到对应的分类
  • 参考现有食谱的格式和结构
  • 确保食谱是纯素食的(不含任何动物成分)
  • 提供清晰的步骤说明和食材用量

2. 分享食材知识和烹饪技巧

你可以:

  • 添加植物性食材的使用方法
  • 分享烹饪技巧和窍门
  • 介绍不同食材的营养价值
  • 提供食材的选购和保存建议

贡献方式:

  • docs/ingredients/docs/cooking/ 目录下添加或修改内容
  • 确保信息准确、实用
  • 参考现有文档的风格和格式

3. 改进文档内容

你可以:

  • 纠正文档中的错误
  • 改进文字表述,使其更清晰易懂
  • 添加有用的提示和建议
  • 改进文档结构和排版

贡献方式:

  • 在 GitHub 上提交 Issue 指出问题
  • 或者直接提交 Pull Request 修复问题

4. 翻译和本地化

你可以:

  • 将文档翻译成其他语言
  • 改进现有翻译的质量
  • 添加文化相关的注释和说明

贡献方式:

  • 在 GitHub 上提交翻译文件
  • 确保翻译准确、流畅
  • 保持与原文档相同的格式和结构

5. 分享经验和见解

你可以:

  • 分享你对素食文化的理解
  • 添加 FAQ 中的常见问题
  • 分享素食生活的经验和建议

贡献流程

第一步:Fork 项目

  1. 访问 HowToCookVegan GitHub 仓库
  2. 点击右上角的 "Fork" 按钮,将项目 Fork 到你的账户

第二步:克隆仓库

git clone https://github.com/你的用户名/HowToCookVegan.git
cd HowToCookVegan

第三步:创建分支

git checkout -b feature/你的贡献内容

例如:

  • feature/add-new-recipe
  • fix/typo-in-ingredients
  • docs/improve-nutrition-section

第四步:进行修改

  • 添加或修改内容
  • 确保遵循项目的格式规范
  • 确保内容准确、实用

第五步:提交更改

git add .
git commit -m "描述你的更改"
git push origin feature/你的贡献内容

提交信息示例:

  • feat: 添加宫保豆腐食谱
  • fix: 修正营养信息的错误
  • docs: 改进食材使用说明

第六步:发起 Pull Request

  1. 访问你的 Fork 仓库
  2. 点击 "New Pull Request"
  3. 填写 Pull Request 的标题和描述
  4. 等待审核和合并

贡献规范

内容规范

  1. 准确性:确保所有信息准确、科学、可靠
  2. 实用性:确保内容对读者有帮助、有价值
  3. 完整性:确保内容完整,不遗漏重要信息
  4. 纯素食:确保所有食谱和内容都是纯素食的(不含任何动物成分)

格式规范

  1. Markdown 格式:使用标准的 Markdown 格式
  2. 文件结构:遵循现有的文件结构和命名规范
  3. 代码风格:保持与现有代码一致的风格
  4. 中文使用:使用简体中文,确保文字流畅、易懂

提交规范

  1. 提交信息:使用清晰的提交信息,说明更改的内容
  2. 原子提交:每次提交只包含一个相关的更改
  3. 测试:在提交前确保内容正确,没有错误

需要帮助?

如果你在贡献过程中遇到问题,可以通过以下方式获取帮助:

  • 提交 Issue:在 GitHub 上提交 Issue,描述你的问题
  • 查看文档:仔细阅读项目文档和相关说明
  • 参考示例:参考现有内容的格式和风格

贡献者权益

所有贡献者都会:

  • 在项目贡献者列表中被列出
  • 获得社区的认可和感谢
  • 帮助更多人学习素食烹饪
  • 为地球的可持续发展贡献力量

🥕 每一次贡献,都是为地球加一份绿色的力量。

感谢您的参与和贡献!