add: issue & pr template

iflytek · Aug 26, 2022 · d51af9e · d51af9e
1 parent 28fbfb9
commit d51af9e
Show file tree

Hide file tree

Showing 8 changed files with 132 additions and 9 deletions.
diff --git a/.github/ISSUE_TEMPLATE/doc_inprovement.yaml b/.github/ISSUE_TEMPLATE/doc_inprovement.yaml
@@ -0,0 +1,25 @@
+name: Documentation Inprovement
+description: As a user, I want to make an enhancement for iflearner docmument
+title: "[Enhancement]: "
+labels: [kind/enhancement]
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thanks for taking the time to suggest an enhancement for iflearner document!
+- type: textarea
+  attributes:
+    label: Which chapter do you think needs improvement?
+    description: A concise description of what you're expecting/suggesting.
+    placeholder: |
+      For example Quickstart/installation
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: What information do you think needs to be added?
+    description: A concise description of the reason/motivation
+    placeholder: |
+      For example Quickstart/installation
+  validations:
+    required: false
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml
@@ -0,0 +1,23 @@
+name: Feature request
+description: As a user, I want to request a feature for iflearner
+title: "[Feature Request]: "
+labels: [kind/feature]
+assignees:
+  - 'dejavu6'
+  - 'xs233'
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to request a feature for iflearner!
+  - type: textarea
+    attributes:
+      label: Describe the type of feature and its functionality.
+      description: A concise description of the problem you are facing or the motivetion behind this feature request..
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Is there something else you want to add?
+    validations:
+      required: false
diff --git a/.github/ISSUE_TEMPLATE/issue_report.yaml b/.github/ISSUE_TEMPLATE/issue_report.yaml
@@ -0,0 +1,30 @@
+name: Bug Report
+description: Create a report to help us reproduce and correct the bug
+labels: ['bug']
+
+body:
+- type: markdown
+  attributes:
+    value: >
+      #### Thanks for taking the time to fill out this bug report!
+      Before submitting a bug, please make sure the issue hasn't been already
+      addressed by searching through [the past issues](https://github.com/iflytek/iflearner/issues).
+- type: textarea
+  attributes:
+    label: Describe the bug
+    description: >
+      A clear and concise description of what the bug is.
+  validations:
+    required: true
+- type: textarea
+  id: logs
+  attributes:
+    label: Additional Information
+    description: Please copy and paste any relevant Info output.
+    render: shell
+  validations:
+    required: false
+- type: markdown
+  attributes:
+    value: >
+      Thanks for contributing!
diff --git a/.github/PULL_REQUEST_TEMPLATE/pr_template.md b/.github/PULL_REQUEST_TEMPLATE/pr_template.md
@@ -0,0 +1,33 @@
+<!--
+Thanks for opening the pull request! Make sure you have viewed at
+the contribution guidelines: https://github.com/iflytek/iflearner/blob/main/doc/docs/tutorial/contributor_guide.md
+
+See Online Docs: https://iflytek.github.io/iflearner/tutorial/contributor_guide/
+
+-->
+
+#### Reference Issues/PRs
+
+<!--
+Please use keywords (e.g., Fixes) to create a link to the issues or pull requests
+you resolved.
+
+Example: Fixes #123. 
+-->
+
+#### What does this implement/fix? Explain your changes.
+
+<!--
+Explain why this PR is needed and what changes you made.
+
+Example: Added a new aggregation strategy, what scenarios will it be suitable for.
+-->
+
+#### Any other comments?
+
+<!--
+Note that it may take some time for the maintainers to review the PR.
+
+We value your contributions and understand the time you put into this PR.
+So thanks for your contribution.
+-->
diff --git a/.github/workflows/publish_pypi.yaml b/.github/workflows/publish_pypi.yaml
@@ -6,8 +6,8 @@ name: PublishPypi
 
 on:
   push:
-    branches:
-      - main
+#    branches:
+#      - main
     # 每次 push tag 时进行构建，不需要每次 push 都构建。使用通配符匹配每次 tag 的提交，记得 tag 名一定要以 v 开头
     tags:
       - v*

diff --git a/README.md b/README.md
@@ -1,8 +1,12 @@
+# iFLearner - A Powerful and Lightweight Federated Learning Framework
 ![](https://img.shields.io/badge/language-python-blue.svg)
-![](https://img.shields.io/badge/license-Apache-000000.svg)
-![Docs](https://github.com/iflytek/iflearner/workflows/DeployDocs/badge.svg)
+[![Forks](https://img.shields.io/github/forks/iflytek/iflearner)](https://img.shields.io/github/forks/iflytek/iflearner)
+[![Stars](https://img.shields.io/github/stars/iflytek/iflearner)](https://img.shields.io/github/stars/iflytek/iflearner)
+[![Docs](https://github.com/iflytek/iflearner/actions/workflows/deploy_doc.yaml/badge.svg)](https://github.com/iflytek/iflearner/actions/workflows/deploy_doc.yaml)
+[![Pypi](https://github.com/iflytek/iflearner/actions/workflows/publish_pypi.yaml/badge.svg)](https://github.com/iflytek/iflearner/actions/workflows/publish_pypi.yaml)
+[![Contributors](https://img.shields.io/github/contributors/iflytek/iflearner)](https://github.com/iflytek/iflearner/graphs/contributors)
+[![License: Apache2.0](https://img.shields.io/github/license/iflytek/iflearner)](https://github.com/iflytek/iflearner/blob/main/LICENSE)
 
-# iFLearner - A Powerful and Lightweight Federated Learning Framework
 [DOCS](https://iflytek.github.io/iflearner/) | [中文](https://iflytek.github.io/iflearner/zh/)
 
 iFLearner is a federated learning framework, which provides a secure computing framework based on 
@@ -36,6 +40,8 @@ The design of iFLearner is based on a few guiding principles:
 * [Quickstart (PyTorch)](https://iflytek.github.io/iflearner/quick_start/quickstart_pytorch/)
 * [Quickstart (MXNet)](https://iflytek.github.io/iflearner/quick_start/quickstart_mxnet/)
 * [Quickstart (keras)](https://iflytek.github.io/iflearner/quick_start/quickstart_keras/)
+* [Quickstart (DP-Opacus)](https://iflytek.github.io/iflearner/quick_start/quickstart_smpc/)
+* [Quickstart (SMPC)](https://iflytek.github.io/iflearner/quick_start/quickstart_opacus/)
 
 ## Contributor
 [Contributor Guide](https://iflytek.github.io/iflearner/tutorial/contributor_guide/)

diff --git a/README_zh.md b/README_zh.md
@@ -1,8 +1,12 @@
+# iFLearner - 一个强大且轻量的联邦学习框架
 ![](https://img.shields.io/badge/language-python-blue.svg)
-![](https://img.shields.io/badge/license-Apache-000000.svg)
-![Docs](https://github.com/iflytek/iflearner/workflows/DeployDocs/badge.svg)
+[![Forks](https://img.shields.io/github/forks/iflytek/iflearner)](https://img.shields.io/github/forks/iflytek/iflearner)
+[![Stars](https://img.shields.io/github/stars/iflytek/iflearner)](https://img.shields.io/github/stars/iflytek/iflearner)
+[![Docs](https://github.com/iflytek/iflearner/actions/workflows/deploy_doc.yaml/badge.svg)](https://github.com/iflytek/iflearner/actions/workflows/deploy_doc.yaml)
+[![Pypi](https://github.com/iflytek/iflearner/actions/workflows/publish_pypi.yaml/badge.svg)](https://github.com/iflytek/iflearner/actions/workflows/publish_pypi.yaml)
+[![Contributors](https://img.shields.io/github/contributors/iflytek/iflearner)](https://github.com/iflytek/iflearner/graphs/contributors)
+[![License: Apache2.0](https://img.shields.io/github/license/iflytek/iflearner)](https://github.com/iflytek/iflearner/blob/main/LICENSE)
 
-# iFLearner - 一个强大且轻量的联邦学习框架
 [DOCS](https://iflytek.github.io/iflearner/zh/) | [英文](https://iflytek.github.io/iflearner/)
 
 iFLearner是一个强大且轻量的联邦学习框架，提供了一种基于数据隐私安全保护的安全计算框架，
@@ -30,6 +34,8 @@ iFLearner主要基于以下原则进行设计:
 * [Quickstart (PyTorch)](https://iflytek.github.io/iflearner/zh/quick_start/quickstart_pytorch/)
 * [Quickstart (MXNet)](https://iflytek.github.io/iflearner/zh/quick_start/quickstart_mxnet/)
 * [Quickstart (keras)](https://iflytek.github.io/iflearner/zh/quick_start/quickstart_keras/)
+* [Quickstart (DP-Opacus)](https://iflytek.github.io/iflearner/zh/quick_start/quickstart_smpc/)
+* [Quickstart (SMPC)](https://iflytek.github.io/iflearner/zh/quick_start/quickstart_opacus/)
 
 ## Contributor
 [Contributor Guide](https://iflytek.github.io/iflearner/zh/tutorial/contributor_guide/)

diff --git a/doc/docs/quick_start/installation.zh.md b/doc/docs/quick_start/installation.zh.md
@@ -11,5 +11,5 @@ pip install iflearner
 
 安装完成后，您可以通过运行以下命令验证是否已成功安装：
 ```shell
-python -c "导入 iflearner;print(iflearner.__version__)"
+python -c "import iflearner;print(iflearner.__version__)"
 ```