From e0003631b551b78cdca0c6c42b7357134d1952ad Mon Sep 17 00:00:00 2001
From: fenghaolin <fenghaolin@huawei.com>
Date: Fri, 25 Jun 2021 08:35:53 +0800
Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0CONTRIBUTING.zh.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 CONTRIBUTING.zh.md | 227 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 227 insertions(+)
 create mode 100644 CONTRIBUTING.zh.md

diff --git a/CONTRIBUTING.zh.md b/CONTRIBUTING.zh.md
new file mode 100644
index 0000000000..ab4566895a
--- /dev/null
+++ b/CONTRIBUTING.zh.md
@@ -0,0 +1,227 @@
+# PyTorch贡献指南
+-   [贡献者许可协议](#贡献者许可协议.md)
+-   [入门](#入门.md)
+-   [开发指导](#开发指导.md)
+    -   [测试用例](#测试用例.md)
+    -   [代码风格](#代码风格.md)
+    -   [门禁异常处理](#门禁异常处理.md)
+    -   [Fork-Pull开发模式](#Fork-Pull开发模式.md)
+    -   [报告问题](#报告问题.md)
+    -   [提出PR](#提出PR.md)
+<h2 id="贡献者许可协议.md">贡献者许可协议</h2>
+
+在您第一次向 PyTorch 社区提交代码之前，需要签署 CLA。
+
+对于个人贡献者，详细信息请参考[ICLA 在线文档](https://www.mindspore.cn/icla)。
+
+<h2 id="入门.md">入门</h2>
+
+-   在[Gitee](https://gitee.com/ascend/pytorch)上Fork存储库。
+-   阅读[README.md](#https://gitee.com/ascend/pytorch/blob/master/README.zh.md)以获取项目信息和构建说明。
+
+<h2 id="开发指导.md">开发指导</h2>
+
+-   **[测试用例](#测试用例.md)**  
+
+-   **[代码风格](#代码风格.md)**  
+
+-   **[门禁异常处理](#门禁异常处理.md)**  
+
+-   **[Fork-Pull开发模式](#Fork-Pull开发模式.md)**  
+
+-   **[报告问题](#报告问题.md)**  
+
+-   **[提出PR](#提出PR.md)**  
+
+
+<h2 id="测试用例.md">测试用例</h2>
+
+通过具体示例，完成PyTorch的功能测试。
+
+1.  编写测试脚本。
+
+    以add运算为例，在“pytorch/test/test\_npu/test\_network\_ops“路径下编写测试脚本文件： test\_add.py。
+
+    以下示例仅为一个简单的用例实现，供用户参考。具体测试用例的实现，需要根据运算定义进行完整的覆盖才能保证功能的基本正确。
+
+    ```
+    # 引入依赖库
+    import sys
+    sys.path.append('..')
+    import torch
+    import numpy as np
+    from common_utils import TestCase, run_tests
+    from common_device_type import dtypes, instantiate_device_type_tests
+    from util_test import create_common_tensor
+    
+    # 定义add测试用例类
+    class TestAdd(TestCase):
+    
+        # 定义CPU的add执行函数
+        def cpu_op_exec(self, input1, input2):
+            output = torch.add(input1, input2, alpha = 1)
+            output = output.numpy()
+            return output
+    
+        # 定义NPU的add执行函数
+        def npu_op_exec_new(self, input1, input2):
+            output = torch.add(input1, input2, alpha = 1)
+            output = output.to("cpu")
+            output = output.numpy()
+            return output
+    
+        # 定义add对应场景通用函数，该函数中负责场景对应输入数据和对比CPU和NPU返回结果
+        def add_result(self, shape_format):
+            for item in shape_format:
+                cpu_input1, npu_input1 = create_common_tensor(item, 0, 100)
+                cpu_input2, npu_input2 = create_common_tensor(item, 0, 100)
+                if cpu_input1.dtype == torch.float16:
+                    cpu_input1 = cpu_input1.to(torch.float32)
+                    cpu_input2 = cpu_input2.to(torch.float32)                
+                cpu_output = self.cpu_op_exec(cpu_input1, cpu_input2)
+                npu_output = self.npu_op_exec_new(npu_input1, npu_input2)
+                cpu_output = cpu_output.astype(npu_output.dtype)            
+                self.assertRtolEqual(cpu_output, npu_output)
+    
+        # 定义具体add场景的测试用例，用例函数需要以test_开头
+        def test_add_shape_format_fp32_2d(self, device):
+            format_list = [0, 3, 29]
+            shape_format = [
+                [np.float32, i, [5, 256]]  for i in format_list 
+            ]        
+            self.add_result(shape_format)
+    
+    instantiate_device_type_tests(TestAdd, globals(), except_for="cpu")
+    if __name__ == "__main__":
+        run_tests()
+    ```
+
+2.  设置环境变量。
+
+    进入“pytorh/src“路径，并执行env.sh脚本。
+
+    ```
+    bash env.sh
+    ```
+
+3.  执行测试用例脚本。
+
+    进入“test\_add.py“所在的目录，执行：
+
+    ```
+    python3.7 test_add.py
+    ```
+
+
+<h2 id="代码风格.md">代码风格</h2>
+
+请遵循这些风格，以使 PyTorch 易于开发、审查和维护。
+
+-   编码指南
+
+    请在PyTorch社区使用规统一的编码分格，_Python__中_建议的编码风格是[PEP 8编码样式](https://pep8.org/)，_C++_编码所建议的风格是  [Google C++编码指南](http://google.github.io/styleguide/cppguide.html)  。可以使用[CppLint](https://github.com/cpplint/cpplint)，[CppCheck](http://cppcheck.sourceforge.net/)，[CMakeLint](https://github.com/cmake-lint/cmake-lint)，[CodeSpell](https://github.com/codespell-project/codespell)，  [Lizard](http://www.lizard.ws/)，[ShellCheck](https://github.com/koalaman/shellcheck)和[pylint](https://pylint.org/)检查代码的格式，建议在您的IDE中安装这些插件。
+
+-   单元测试指南
+
+    请在PyTorch社区使用统一的单元测试风格，  _Python_中建议的单元测试风格是[pytest](http://www.pytest.org/en/latest/)，_C++_单元测试所建议的风格是  [Googletest Primer](#https://github.com/google/googletest/blob/master/docs/primer.md)  。测试用例的设计意图应该通过它的注释名称来反映。
+
+-   重构指南
+
+    我们鼓励开发人员重构我们的代码以消除[代码异味](https://en.wikipedia.org/wiki/Code_smell)。所有的代码都应该符合编码风格和测试风格的需求，重构代码也不例外。当您收到警告时，您必须重构要合并的代码。
+
+
+<h2 id="门禁异常处理.md">门禁异常处理</h2>
+
+门禁异常主要包含如下几种，请根据相关提示解决异常问题。
+
+-   编译异常
+
+    请检查代码编译失败的原因，解决问题后重新编译即可。
+
+-   静态检查异常（代码Bug、代码漏洞、代码异味）
+
+    请依照提示查找代码中的异常并解决。
+
+-   UT测试未通过
+
+    请根据提示，查找测试用例不通过项并检查原因，解决后再测试。
+
+
+<h2 id="Fork-Pull开发模式.md">Fork-Pull开发模式</h2>
+
+1.  Fork PyTorch存储库。
+
+    在向PyTorch项目提交代码之前，请确保该项目已经Fork到您自己的存储库。这意味着PyTorch存储库和您自己的存储库之间将存在并行开发，因此请注意避免存储库之间的不一致。
+
+2.  克隆远程仓库。
+
+    如果要将代码下载到本地环境，git是很好的方法：
+
+    ```
+    # For Gitee
+    git clone https://gitee.com/{insert_your_forked_repo}/pytorch.git
+    git remote add upstream https://gitee.com/pytorch/pytorch.git
+    ```
+
+3.  本地开发代码。
+
+    为了避免多个分支之间的不一致，建议签出到一个新的分支：
+
+    ```
+    git checkout -b {new_branch_name} origin/master
+    ```
+
+    以master分支为例，PyTorch可能会根据需要创建版本分支和下游开发分支，请先修复上游的bug。然后就可以随意更改代码了。
+
+4.  将代码推送到远程仓库。
+
+    更新代码后，您需要以正式的方式推送更新：
+
+    ```
+    git add .
+    git status # Check the update status
+    git commit -m "Your commit title"
+    git commit -s --amend #Add the concrete description of your commit
+    git push origin {new_branch_name}
+    ```
+
+5.  向 PyTorh存储库拉取请求。
+
+    在最后一步中，您需要在新分支和“PyTorch master“分支之间拉取比较请求。完成拉取请求后，“Jenkins CI“将自动设置为构建测试。您的pull request应该尽快合并到上游 master 分支，以降低合并的风险。
+
+
+<h2 id="报告问题.md">报告问题</h2>
+
+为项目做出贡献的一个好方法是在遇到问题时发送详细报告。我们总是很感激写得很好、彻底的错误报告，并会由此感谢您！
+
+报告问题时，请参考以下格式：
+
+-   您使用的是什么版本的环境 （pytorch、os、python 等）？
+-   这是错误报告还是功能请求？
+-   什么样的问题，添加标签以在问题仪表板上突出显示。
+-   发生了什么？
+-   您预计会发生什么？
+-   如何重现它？（尽可能最小和精确。）
+-   给审稿人的特别说明？
+
+问题咨询：
+
+-   如果您发现一个未解决的问题，而这正是您要解决的问题，请对该问题发表一些评论，告诉其他人您将负责它。
+-   如果问题已打开一段时间，建议贡献者在解决该问题之前进行预检查。
+-   如果您解决了自己报告的问题，则还需要在关闭该问题之前让其他人知道。
+
+<h2 id="提出PR.md">提出PR</h2>
+
+-   在[Gitee](https://gitee.com/ascend/pytorch/issues)上提出您的想法作为_问题_。
+-   如果是需要大量设计细节的新功能，还应提交设计方案。
+-   在问题讨论和设计提案审查中达成共识后，完成分叉回购的开发并提交 PR（Pull Request）。
+-   在从批准者那里收到2+ LGTM（Looks Good To Me）之前，不允许任何PR 。请注意，审批人不允许在自己的 PR 上添加LGTM。
+-   在 PR 被充分讨论后，它将根据讨论的结果被合并、放弃或拒绝。
+
+公关咨询：
+
+-   应避免任何不相关的更改。
+-   确保你的提交历史被排序。
+-   始终将您的分支与主分支保持一致。
+-   对于错误修复 PR，请确保链接所有相关问题。
+
-- 
Gitee