贡献指南

简介

BioEZ 是一个开源项目，旨在为各个年龄段的用户提供生物学教程，涵盖食品检测、微生物学、DNA 等多个主题。我们欢迎社区的贡献，帮助改进和扩展这些教程。

如何贡献

您可以通过以下方式为 BioEZ 做出贡献：

• 报告教程中的错误或问题。

• 建议新的教程主题或对现有教程的改进。

• 编写新的教程或更新现有教程。

• 改进项目的文档。

设置开发环境

要开始贡献，请确保您已经安装了 Git 和一个 Markdown 编辑器（如 Obsidian、Typora 或 Visual Studio Code），然后按照以下步骤操作：

1. 在 GitHub 上 Fork BioEZ 仓库到您的账户。

2. 克隆 Fork 的仓库到本地：

   git clone https://github.com/YOUR_USERNAME/BioEZ.git
   

   请将 YOUR_USERNAME 替换为您的 GitHub 用户名。

3. 打开克隆的仓库文件夹，使用 Markdown 编辑器编辑文件。

编写标准

编写教程时，请遵循以下准则：

• 使用清晰、简洁的语言。

• 必要时包含图片、图表或视频。

• 保持教程结构一致，例如：介绍、材料、方法、结果、讨论等。

• 使用正确的 Markdown 语法。

• 尊重版权，确保所有引用的材料都有适当的许可。

提交 Pull Request

提交贡献时，请遵循以下步骤：

1. 在您的 Fork 仓库中创建一个新的分支：

   git checkout -b feature/add-new-tutorial
   

2. 在该分支上进行您的更改。

3. 提交您的更改，并编写清晰的提交消息：

   git commit -m 'Add new tutorial: Genetics'
   

4. 将您的分支推送到 GitHub：

   git push origin feature/add-new-tutorial
   

5. 在 GitHub 上提交一个 Pull Request，描述您的更改和目的。

6. 等待项目维护者的审查和合并。

报告问题

如果您发现教程中的错误或有改进建议，请在 GitHub Issues 中提交问题报告。请提供详细的信息，包括问题的描述、复现步骤（如果适用）以及任何相关的截图或文件。

建议新功能

如果您有新的教程主题或功能建议，请在 GitHub Issues 中提交建议。请描述您的想法以及它将如何改进项目。

许可证

BioEZ 项目采用 CC BY-SA 4.0 许可证。提交贡献即表示您同意您的贡献也在此许可证下发布。

订阅小倪的网站

• 您可以随时取消订阅