update contributing file (#664)
This commit is contained in:
TobeyQin
GitHub
Родитель
77bf37a646
Коммит
a5b3855a0b
|
|
@ -11,13 +11,13 @@
|
|||
|
||||
## 您可以贡献的内容
|
||||
|
||||
### 贡献人工智能基础或高级教程到[A-基础教程](./A-基础教程)
|
||||
### 贡献人工智能基础或高级教程到[基础教程](../基础教程)
|
||||
如果您想贡献新的人工智能教程到此模块，您需要确保所贡献内容是原创内容，建议您提前与我们沟通联系和讨论。您可以发送邮件到[opencode@microsoft.com](mailto:opencode@microsoft.com) 或 在GitHub上创建 [issue](https://github.com/Microsoft/ai-edu/issues)。
|
||||
|
||||
如果您想对已有教程进行修改或补充，您可以按照[贡献内容主要步骤](#贡献内容主要步骤)进行操作，并提交PR，我们会及时处理。
|
||||
|
||||
### 贡献案例和文档到[B-实践案例](./B-实践案例)
|
||||
我们欢迎您贡献原创的案例和配套的文档、解决方案到模块[B-实践案例](./B-实践案例)。对于文档和图例，您可以将其直接添加到该模块中；对于配套的解决方案源代码，我们建议您新建一个专门的GitHub仓库用于放置和更新源代码，并将该仓库的链接粘贴到教案描述中。
|
||||
### 贡献案例和文档到[实践案例](../实践案例)
|
||||
我们欢迎您贡献原创的案例和配套的文档、解决方案到模块[实践案例](../实践案例)。对于文档和图例，您可以将其直接添加到该模块中；对于配套的解决方案源代码，我们建议您新建一个专门的GitHub仓库用于放置和更新源代码，并将该仓库的链接粘贴到教案描述中。
|
||||
|
||||
该模块的内容是按如下的文件夹结构来组织的：
|
||||
```
|
||||
|
|
@ -43,20 +43,18 @@ B:教学案例与实践
|
|||
|
||||
您可以按照如下步骤添加您的案例和解决方案：
|
||||
|
||||
1. 请在模块[B-实践案例](./B-实践案例)下新建一个案例文件夹，案例文件夹名应是您的案例名字（比如 `量化交易案例` ）。并在案例文件夹新建案例描述文件 `README.md`。
|
||||
1. 请在模块[实践案例](../实践案例)下新建一个案例文件夹，案例文件夹名应是您的案例名字（比如 `量化交易案例` ）。并在案例文件夹新建案例描述文件 `README.md`。
|
||||
|
||||
1. 在案例文件夹中新建一个解决方案文件夹，并为它设置一个易于分辨的名字，以便将您的解决方案和后续的其他解决方案区分开来（比如 `微软-方案1` ）。
|
||||
|
||||
1. 如果模块[B-实践案例](./B-实践案例)下已经存在同名的案例文件夹，您可以直接按照第2步，在该案例文件夹中添加新的解决方案文件夹。
|
||||
1. 如果模块[实践案例](../实践案例)下已经存在同名的案例文件夹，您可以直接按照第2步，在该案例文件夹中添加新的解决方案文件夹。
|
||||
|
||||
对于案例文件夹，我们推荐您将您案例的主题作为文件夹的名字，比如 `量化交易案例` 或 `语言理解应用案例 - 智能家具`。
|
||||
如果您有多个属于同一系列（比如 `AI301系列`）的案例，我们推荐您使用系列名称作为案例文件夹名字的前缀，比如 `AI301 - 量化交易案例`。
|
||||
对于案例文件夹，我们推荐您将您案例的主题作为文件夹的名字，前缀加上模块序号和案例序号。比如 `B11-量化交易案例` 或 `B04-智能家居`。
|
||||
|
||||
对于解决方案文件夹，我们推荐您使用 `机构/个人名称 + 方案技术要点` 的格式来为其命名。比如 `微软-基于Tools for AI`。
|
||||
|
||||
我们欢迎您同时提供与解决方案相对应的源代码。为了方便您更新和维护源代码，我们建议您创建一个专门的GitHub仓库用于放置和更新源代码，并将该仓库的链接粘贴到教案描述中。（关于如何创建新的GitHub仓库，请参考<https://help.github.com/en/articles/create-a-repo>。）
|
||||
|
||||
|
||||
## 在提交Pull request之前，请确保：
|
||||
- 如您的贡献内容引用了本社区的原创内容，请声明并注明出处。
|
||||
- 您提交的内容不是重复的内容。
|
||||
|
|
@ -83,9 +81,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
|
|||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
||||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
||||
## 本社区注明版权出处的内容适用于[License](./LICENSE.md)版权许可。
|
||||
|
||||
|
||||
## 本社区注明版权出处的内容适用于[License](../LICENSE.md)版权许可。
|
||||
|
||||
# 社区体验和代码贡献技巧
|
||||
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче