This repository has been archived by the owner on Sep 18, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
213 changed files
with
17,033 additions
and
12,235 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# 贡献代码 | ||
|
||
非常感谢您有兴趣对 NNI 做出贡献! | ||
|
||
除了编写代码外,您还可以通过多种方式参与, 本文档的目的是提供一个如何参与贡献的高层次概述。 | ||
|
||
# 反馈或提问 | ||
|
||
* 在 Github 上创建 [issue](https://github.com/microsoft/nni/issues/new/choose)。 | ||
* 在 [Stack Overflow](https://stackoverflow.com/questions/tagged/nni?sort=Newest&edited=true) 上使用 nni 标签提问。 | ||
* 在 [Gitter](https://gitter.im/Microsoft/nni?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) 中参与讨论。 | ||
|
||
加入聊天组: | ||
| Gitter | | 微信 | | ||
| -------------------------------------------------------------------------------------------------------------- | - | ----------------------------------------------------------------------- | | ||
| ![image](https://user-images.githubusercontent.com/39592018/80665738-e0574a80-8acc-11ea-91bc-0836dc4cbf89.png) | 或 | ![image](https://github.com/scarlett2018/nniutil/raw/master/wechat.png) | | ||
|
||
|
||
# 查找现有问题 | ||
在创建新 issue 之前,请在 [open issues](https://github.com/microsoft/nni/issues) 中进行搜索,以查看问题或功能请求是否已经存在。 | ||
|
||
确保已经浏览了 [最热门](https://github.com/microsoft/nni/issues?q=is%3Aopen+is%3Aissue+label%3AFAQ+sort%3Areactions-%2B1-desc) 的功能请求。 | ||
|
||
如果您的问题已经存在,请在下方发表评论或添加[回应](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments)。 通过回应来代替“+1”评论: | ||
|
||
* 👍 - 赞成 | ||
* 👎 - 反对 | ||
|
||
如果未能找到描述您 Bug 或功能的现有问题,请使用以下指南创建一个新问题。 | ||
|
||
# 编写良好的错误报告或功能请求 | ||
针对每个错误和功能请求提交一个问题, 不要在同一问题中列举多个 Bug 或功能请求。 | ||
|
||
尽可能多地提供您认为与上下文相关的信息(思考问题如果分配给您,您需要什么样的信息来调试它)。 为了让您大致了解哪些信息对开发人员解决问题有帮助,我们为您提供了问题模板。 | ||
|
||
提交问题后,请务必跟进问题并参与讨论。 | ||
|
||
修正 Bug 或实现功能后,请务必关闭此问题。 | ||
|
||
# 贡献修复或示例 | ||
|
||
此项目欢迎任何贡献和建议。 大多数贡献需要您同意参与者许可协议(CLA),来声明您有权并授予我们使用您贡献的权利。 有关详细信息,请访问 https://cla.opensource.microsoft.com。 | ||
|
||
当你提交拉取请求时,CLA 机器人会自动检查你是否需要提供 CLA,并修饰这个拉取请求(例如标签、注释等)。 只需要按照机器人提供的说明进行操作即可。 CLA 只需要同意一次,就能应用到所有的代码仓库上。 | ||
|
||
# 行为准则 | ||
|
||
该项目采用了 [ Microsoft 开源行为准则 ](https://opensource.microsoft.com/codeofconduct/)。 有关详细信息,请参阅[行为守则常见问题解答](https://opensource.microsoft.com/codeofconduct/faq/)或联系 [email protected] 咨询问题或评论。 | ||
|
||
# 参与贡献 | ||
|
||
熟悉贡献协议后,即可按照 NNI 开发人员教程,创建第一个 PR =): | ||
|
||
* 推荐新贡献者先从简单的问题开始:['good first issue'](https://github.com/Microsoft/nni/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) 或 ['help-wanted'](https://github.com/microsoft/nni/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)。 | ||
* [NNI 开发环境安装教程](docs/zh_CN/Tutorial/SetupNniDeveloperEnvironment.rst) | ||
* [如何调试](docs/zh_CN/Tutorial/HowToDebug.rst) | ||
* 如果有使用上的问题,可先查看[常见问题解答](https://github.com/microsoft/nni/blob/master/docs/zh_CN/Tutorial/FAQ.rst)。如果没能解决问题,可通过 [Gitter](https://gitter.im/Microsoft/nni?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) 联系 NNI 开发团队或在 GitHub 上 [报告问题](https://github.com/microsoft/nni/issues/new/choose)。 | ||
* [自定义 Tuner](docs/zh_CN/Tuner/CustomizeTuner.rst) | ||
* [实现定制的训练平台](docs/zh_CN/TrainingService/HowToImplementTrainingService.rst) | ||
* [在 NNI 上实现新的 NAS Trainer](docs/zh_CN/NAS/Advanced.rst) | ||
* [自定义 Advisor](docs/zh_CN/Tuner/CustomizeAdvisor.rst) | ||
|
Oops, something went wrong.