From aab1789947742754dd85b69feac0f47a9a501e47 Mon Sep 17 00:00:00 2001 From: Ligoml <39876205+Ligoml@users.noreply.github.com> Date: Fri, 1 Apr 2022 19:52:36 +0800 Subject: [PATCH] update ISSUE_TEMPLATE (#41271) * add/rm ISSUE_TEMPLATE * rm old template * "ci;test=document_fix" --- .github/ISSUE_TEMPLATE/---document-issue-.md | 59 ----------------- .github/ISSUE_TEMPLATE/---feature-request-.md | 29 -------- .github/ISSUE_TEMPLATE/---inference-issue-.md | 42 ------------ .../ISSUE_TEMPLATE/---installation-issue-.md | 43 ------------ .github/ISSUE_TEMPLATE/---model-issue-.md | 38 ----------- .github/ISSUE_TEMPLATE/---others-.md | 35 ---------- .github/ISSUE_TEMPLATE/---training-issue-.md | 40 ----------- .github/ISSUE_TEMPLATE/1_bug-report.yml | 66 +++++++++++++++++++ .github/ISSUE_TEMPLATE/2_feature-request.yml | 37 +++++++++++ .../3_build-installation-issue.yml | 65 ++++++++++++++++++ .../ISSUE_TEMPLATE/4_documentation-issue.yml | 39 +++++++++++ .github/ISSUE_TEMPLATE/5_ask-a-question.yml | 33 ++++++++++ .github/ISSUE_TEMPLATE/6_others.yml | 26 ++++++++ 13 files changed, 266 insertions(+), 286 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/---document-issue-.md delete mode 100644 .github/ISSUE_TEMPLATE/---feature-request-.md delete mode 100644 .github/ISSUE_TEMPLATE/---inference-issue-.md delete mode 100644 .github/ISSUE_TEMPLATE/---installation-issue-.md delete mode 100644 .github/ISSUE_TEMPLATE/---model-issue-.md delete mode 100644 .github/ISSUE_TEMPLATE/---others-.md delete mode 100644 .github/ISSUE_TEMPLATE/---training-issue-.md create mode 100644 .github/ISSUE_TEMPLATE/1_bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/2_feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/3_build-installation-issue.yml create mode 100644 .github/ISSUE_TEMPLATE/4_documentation-issue.yml create mode 100644 .github/ISSUE_TEMPLATE/5_ask-a-question.yml create mode 100644 .github/ISSUE_TEMPLATE/6_others.yml diff --git a/.github/ISSUE_TEMPLATE/---document-issue-.md b/.github/ISSUE_TEMPLATE/---document-issue-.md deleted file mode 100644 index ffc2fcd7817..00000000000 --- a/.github/ISSUE_TEMPLATE/---document-issue-.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -name: 文档(Document Issue) -about: 您可以提问文档相关的问题。 You could use this template for reporting an document issue. - ---- - -非常感谢您提交关于飞桨文档的Issue,我们会认真听取您的意见,并进行改进。 - -建立issue时,为快速解决问题,请您根据情况给出如下信息: -- 标题:请包含关键词“XXX文档问题”,例如“add 文档问题” 或 ”paddle.add 文档问题“ -- 文档版本信息:请提供有问题的文档的版本号,例如 develop,1.8,2.0RC; - -### 文档问题描述: - -#### API文档描述是否清晰? -如:文档描述看不懂,不知道这个API该怎么用;文档公式错误; - -#### 参数说明是否清晰 -如:参数未解释清楚,包括用法、使用场景、默认值等 - -#### 返回/形状说明是否清晰 -如:API返回值、数据的形状描述错误、不清楚 - -#### 示例代码是否有效? -如:没有示例代码;示例代码没有可指导性;示例代码跑不通;示例代码格式有问题;示例代码没有注释; - -#### 中英文内容是否一致? -如:中英文API描述不一致;中英文API参数不一致; - -#### 其他 -如:文档页面打不开;文档缺失;文档中有死链; - - -Thanks for opening a document issue. We will listen to your opinions carefully and make improvements. - -In order to quickly solve your problem, when creating an issue, please provide the following information: -**Document Information** -- Title:Please include the keyword "XXX document issue", such as "add document issue" or "paddle.add document issue" -- Doc Version:Please provide the version of the document, such as develop, 1.8, 2.0RC; - -### Describe the problem: - -#### Document description is clear? -For example: I don’t understand this document, I don’t know how to use this API; The formula in this doc is unclear; - -#### Parameter description is clear? -For example: The parameters are confusing, including usage, scenarios, default values, etc. - -#### Return/Shape description is clear -For example: Data returned this doc is error, shape returned is not clear. - -#### The sample code is clear? -For example: no sample code; The sample code is not helpful; The sample code not run well; Format of the sample is not reasonable; The sample code has no comments. - -#### Chinese content and English content is consistent? -For example:Chinese API in this doc is inconsistent with English API, including params, description, sample code, formula, etc. - -#### Other -For example: The doc link is broken; The doc page is missing; Dead link in docs. diff --git a/.github/ISSUE_TEMPLATE/---feature-request-.md b/.github/ISSUE_TEMPLATE/---feature-request-.md deleted file mode 100644 index 7af1f7daeef..00000000000 --- a/.github/ISSUE_TEMPLATE/---feature-request-.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -name: 建议(Feature request) -about: 您可以提出您的建议。 You could use this template for reporting a suggestion  issue. - ---- - -欢迎您对PaddlePaddle提出建议,非常感谢您对PaddlePaddle的贡献! -在留下您的建议时,辛苦您同步提供如下信息: -- 版本、环境信息 -1)PaddlePaddle版本:请提供您的PaddlePaddle版本号,例如1.1 -2)CPU/GPU:您是否使用GPU进行训练,如是,请提供您的CUDA和cuDNN版本号 -3)系统环境:请您描述系统类型、版本,例如Mac OS 10.14 -注:您可以通过执行[summary_env.py](https://github.com/PaddlePaddle/Paddle/blob/develop/tools/summary_env.py)获取以上信息。 -- 复现信息:如为报错,请给出复现环境、复现步骤 -- 建议描述:请您详细描述,您认为需优化的功能 - -Thank you for contributing to PaddlePaddle. -Before submitting the issue, you could search issue in the github in case that there was a similar issue submitted or resolved before. -Please make sure that this is a feature request. -**System information** --PaddlePaddle version (eg.1.1)or CommitID --CPU: including CPUMKL/OpenBlas/MKLDNN version --GPU: including CUDA/CUDNN version --OS Platform (eg.Mac OS 10.14) -Note: You can get most of the information by running [summary_env.py](https://github.com/PaddlePaddle/Paddle/blob/develop/tools/summary_env.py). -**To Reproduce** -Steps to reproduce the behavior -**Describe the feature and the current behavior/state.** -**Any Other info.** diff --git a/.github/ISSUE_TEMPLATE/---inference-issue-.md b/.github/ISSUE_TEMPLATE/---inference-issue-.md deleted file mode 100644 index ceb8b12d805..00000000000 --- a/.github/ISSUE_TEMPLATE/---inference-issue-.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -name: 预测(Inference Issue) -about: 您可以提问预测中报错、应用等问题。 You could use this template for reporting an inference issue. - ---- - -为使您的问题得到快速解决,在建立Issue前,请您先通过如下方式搜索是否有相似问题:【搜索issue关键字】【使用labels筛选】【官方文档】 - -如果您没有查询到相似问题,为快速解决您的提问,建立issue时请提供如下细节信息: -- 标题:简洁、精准描述您的问题,例如“最新预测库的API文档在哪儿 ” -- 版本、环境信息: -    1)PaddlePaddle版本:请提供您的PaddlePaddle版本号(如1.1)或CommitID -    2)CPU:预测若用CPU,请提供CPU型号,MKL/OpenBlas/MKLDNN/等数学库使用情况 -    3)GPU:预测若用GPU,请提供GPU型号、CUDA和CUDNN版本号 -    4)系统环境:请您描述系统类型、版本(如Mac OS 10.14),Python版本 -注:您可以通过执行[summary_env.py](https://github.com/PaddlePaddle/Paddle/blob/develop/tools/summary_env.py)获取以上信息。 --预测信息 -    1)C++预测:请您提供预测库安装包的版本信息,及其中的version.txt文件 -    2)CMake包含路径的完整命令 -    3)API信息(如调用请提供) -    4)预测库来源:官网下载/特殊环境(如BCLOUD编译) -- 复现信息:如为报错,请给出复现环境、复现步骤 -- 问题描述:请详细描述您的问题,同步贴出报错信息、日志/代码关键片段 - -Thank you for contributing to PaddlePaddle. -Before submitting the issue, you could search issue in the github in case that th -If there is no solution,please make sure that this is an inference issue including the following details : -**System information** --PaddlePaddle version (eg.1.1)or CommitID --CPU: including CPUMKL/OpenBlas/MKLDNN version --GPU: including CUDA/CUDNN version --OS Platform (eg.Mac OS 10.14) --Python version --Cmake orders --C++version.txt --API information -Note: You can get most of the information by running [summary_env.py](https://github.com/PaddlePaddle/Paddle/blob/develop/tools/summary_env.py). -**To Reproduce** -Steps to reproduce the behavior -**Describe your current behavior** -**Code to reproduce the issue** -**Other info / logs** diff --git a/.github/ISSUE_TEMPLATE/---installation-issue-.md b/.github/ISSUE_TEMPLATE/---installation-issue-.md deleted file mode 100644 index 5e761a6605a..00000000000 --- a/.github/ISSUE_TEMPLATE/---installation-issue-.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -name: 安装(Installation Issue) -about: 您可以提问安装、编译出现报错等问题。 You could use this template for reporting an installation -  issue. - ---- - -为使您的问题得到快速解决,在建立Issue前,请您先通过如下方式搜索是否有相似问题:【搜索issue关键字】【使用labels筛选】【官方文档】 - -建立issue时,为快速解决问题,请您根据使用情况给出如下信息: -- 标题:请包含关键词“安装错误”/“编译错误”,例如“Mac编译错误” -- 版本、环境信息: -    1)PaddlePaddle版本:请提供您的PaddlePaddle版本号(如1.1)或CommitID -    2)CPU:请提供CPU型号,MKL/OpenBlas/MKLDNN/等数学库的使用情况 -    3)GPU:请提供GPU型号,CUDA和CUDNN版本号 -    4)系统环境:请说明系统类型、版本(如Mac OS 10.14)、Python版本 -注:您可以通过执行[summary_env.py](https://github.com/PaddlePaddle/Paddle/blob/develop/tools/summary_env.py)获取以上信息。 -- 安装方式信息: -1)pip安装/docker安装 -2)本地编译:请提供cmake命令,编译命令 -3)docker编译:请提供docker镜像,编译命令            -  特殊环境请注明:如离线安装等 -- 复现信息:如为报错,请给出复现环境、复现步骤 -- 问题描述:请详细描述您的问题,同步贴出报错信息、日志/代码关键片段 - -Thank you for contributing to PaddlePaddle. -Before submitting the issue, you could search issue in Github in case that there was a similar issue submitted or resolved before. -If there is no solution,please make sure that this is an installation issue including the following details: -**System information** --PaddlePaddle version (eg.1.1)or CommitID --CPU: including CPUMKL/OpenBlas/MKLDNN version --GPU: including CUDA/CUDNN version --OS Platform (eg. Mac OS 10.14) --Python version -- Install method: pip install/install with docker/build from source(without docker)/build within docker -- Other special cases that you think may be related to this problem, eg. offline install, special internet condition -Note: You can get most of the information by running [summary_env.py](https://github.com/PaddlePaddle/Paddle/blob/develop/tools/summary_env.py).   - -**To Reproduce** -Steps to reproduce the behavior -**Describe your current behavior** -**Code to reproduce the issue** -**Other info / logs** diff --git a/.github/ISSUE_TEMPLATE/---model-issue-.md b/.github/ISSUE_TEMPLATE/---model-issue-.md deleted file mode 100644 index 1e7c2e9c3e9..00000000000 --- a/.github/ISSUE_TEMPLATE/---model-issue-.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: 模型(Model Issue) -about: 您可以提问模型、算法、数据集方向的使用报错等问题。You could use this template for reporting a model/ - algorithm/dataset  issue. - ---- - -为使您的问题得到快速解决,在建立Issue前,请您先通过如下方式搜索是否有相似问题:【搜索issue关键字】【使用labels筛选】【官方文档】 - -建立issue时,为快速解决问题,请您根据使用情况给出如下信息: -- 标题:简洁、精准描述您的问题,例如“ssd 模型前置lstm报错  ” -- 版本、环境信息: -    1)PaddlePaddle版本:请提供PaddlePaddle版本号,例如1.1或CommitID -    2)CPU:请提供CPU型号,MKL/OpenBlas/MKLDNN/等数学库的使用情况 -    3)GPU:请提供GPU型号,CUDA和CUDNN版本号 -    4)系统环境:请说明系统类型、版本(例如Mac OS 10.14),Python版本 - 注:您可以通过执行[summary_env.py](https://github.com/PaddlePaddle/Paddle/blob/develop/tools/summary_env.py)获取以上信息。 -- 模型信息 -    1)模型名称 2)使用数据集名称 3)使用算法名称 4)模型链接 -- 复现信息:如为报错,请给出复现环境、复现步骤 -- 问题描述:请详细描述您的问题,同步贴出报错信息、日志/代码关键片段 - -Thank you for contributing to PaddlePaddle. -Before submitting the issue, you could search issue in the github.Probably there was a similar issue submitted or resolved before. -If there is no solution,please make sure that this is a issue of models including the following details: -**System information** --PaddlePaddle version (eg.1.1)or CommitID --CPU: including CPUMKL/OpenBlas/MKLDNN version --GPU: including CUDA/CUDNN version --OS Platform (eg.Mac OS 10.14) --Python version --Name of Models&Dataset/details of operator -Note: You can get most of the information by running [summary_env.py](https://github.com/PaddlePaddle/Paddle/blob/develop/tools/summary_env.py). -**To Reproduce** -Steps to reproduce the behavior -**Describe your current behavior** -**Code to reproduce the issue** -**Other info / logs** diff --git a/.github/ISSUE_TEMPLATE/---others-.md b/.github/ISSUE_TEMPLATE/---others-.md deleted file mode 100644 index ebab9023a63..00000000000 --- a/.github/ISSUE_TEMPLATE/---others-.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: 其他(Others) -about: 如上述分类未包含您的问题,可在此提出。 You could use this template for reporting other issues - ---- - -为使您的问题得到快速解决,在建立Issues前,请您先通过如下方式搜索是否有相似问题:【搜索issue关键字】【使用labels筛选】【官方文档】 - -如果您没有查询到相似问题,为快速解决您的提问,建立issue时请提供如下细节信息: -- 标题:简洁、精准概括您的问题 -- 版本、环境信息: -    1)PaddlePaddle版本:请提供您的PaddlePaddle版本号,例如1.1或CommitID -    2)CPU/GPU:如果您使用GPU训练,请提供GPU驱动版本、CUDA和cuDNN版本号 -    3)系统环境:请您描述系统类型、版本,例如Mac OS 10.14 -    4)Python版本号 -    5)显存信息 - 注:您可以通过执行[summary_env.py](https://github.com/PaddlePaddle/Paddle/blob/develop/tools/summary_env.py)获取以上信息。 -- 复现信息:如为报错,请给出复现环境、复现步骤 -- 问题描述:请详细描述您的问题,同步贴出报错信息、日志/代码关键片段 - -Thank you for contributing to PaddlePaddle. -Before submitting the issue, you could search issue in the github in case that there was a similar issue submitted or resolved before. -If there is no solution,please provide us with the following details : -**System information** --PaddlePaddle version (eg.1.1)or CommitID --CPU: including CPUMKL/OpenBlas/MKLDNN version --GPU: including CUDA/cuDNN version --OS Platform and Distribution(eg.Mac OS 10.14) --Python version -Note: You can get most of the information by running [summary_env.py](https://github.com/PaddlePaddle/Paddle/blob/develop/tools/summary_env.py). -**To Reproduce** -Steps to reproduce the behavior -**Describe your current behavior** -**Code to reproduce the issue** -**Other info / logs** diff --git a/.github/ISSUE_TEMPLATE/---training-issue-.md b/.github/ISSUE_TEMPLATE/---training-issue-.md deleted file mode 100644 index 15aa077619d..00000000000 --- a/.github/ISSUE_TEMPLATE/---training-issue-.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -name: 训练(Training issue) -about: 您可以提问训练中报错、应用、出core等问题。 You could use this template for reporting an training -  issue. - ---- - -为使您的问题得到快速解决,在建立Issues前,请您先通过如下方式搜索是否有相似问题:【搜索issue关键字】【使用labels筛选】【官方文档】 - -如果您没有查询到相似问题,为快速解决您的提问,建立issue时请提供如下细节信息: -- 标题:简洁、精准概括您的问题,例如“Insufficient Memory xxx" ” -- 版本、环境信息: -    1)PaddlePaddle版本:请提供您的PaddlePaddle版本号,例如1.1或CommitID -    2)CPU:预测若用CPU,请提供CPU型号,MKL/OpenBlas/MKLDNN/等数学库使用情况 -    3)GPU:预测若用GPU,请提供GPU型号、CUDA和CUDNN版本号 -    4)系统环境:请您描述系统类型、版本,例如Mac OS 10.14,Python版本 - 注:您可以通过执行[summary_env.py](https://github.com/PaddlePaddle/Paddle/blob/develop/tools/summary_env.py)获取以上信息。 -- 训练信息 -    1)单机/多机,单卡/多卡 -    2)显存信息 -    3)Operator信息 -- 复现信息:如为报错,请给出复现环境、复现步骤 -- 问题描述:请详细描述您的问题,同步贴出报错信息、日志、可复现的代码片段 - -Thank you for contributing to PaddlePaddle. -Before submitting the issue, you could search issue in the github in case that there was a similar issue submitted or resolved before. -If there is no solution,please make sure that this is a training issue including the following details: -**System information** --PaddlePaddle version (eg.1.1)or CommitID --CPU: including CPUMKL/OpenBlas/MKLDNN version --GPU: including CUDA/CUDNN version --OS Platform (eg.Mac OS 10.14) --Other imformation: Distriuted training/informantion of operator/ -Graphics card storage -Note: You can get most of the information by running [summary_env.py](https://github.com/PaddlePaddle/Paddle/blob/develop/tools/summary_env.py). -**To Reproduce** -Steps to reproduce the behavior -**Describe your current behavior** -**Code to reproduce the issue** -**Other info / logs** diff --git a/.github/ISSUE_TEMPLATE/1_bug-report.yml b/.github/ISSUE_TEMPLATE/1_bug-report.yml new file mode 100644 index 00000000000..058589232fe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_bug-report.yml @@ -0,0 +1,66 @@ + +name: 🐛 报BUG Bug Report +description: 报告一个可复现的BUG帮助我们修复框架。 Report a bug to help us reproduce and fix it. +labels: [type/bug-report, status/new-issue] + +body: +- type: markdown + attributes: + value: > + #### 在向Paddle报bug之前,请先查询[历史issue](https://github.com/PaddlePaddle/Paddle/issues)是否报过同样的bug。 + + #### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/PaddlePaddle/Paddle/issues). + +- type: textarea + id: code + attributes: + label: bug描述 Describe the Bug + description: | + 请清晰简洁的描述这个bug,最好附上bug复现环境、bug复现步骤及最小代码集,以便我们可以通过运行代码来重现错误。代码片段需要尽可能简洁,请花些时间去掉不相关的代码以帮助我们有效地调试。我们希望通过复制代码并运行得到与你相同的结果,请避免任何外部数据或包含相关的导入等。例如: + ```python + # 导入所有必要的库。 All necessary imports at the beginning. + # paddlepaddle <= 2.1.2 + import paddle + + # 一个简洁的片段,能够定位到bug。 A succinct reproducing example trimmed down to the essential parts. + a = paddle.rand(shape=[1,4]) + b = paddle.rand(shape=[1,4]) + a.stop_gradient = False + b.stop_gradient = False + + c = paddle.zeros((4, 4)) + c[0, :] = a/b + + print('Is c requires grad: ', not c.stop_gradient) # 注意:这里出现了bug,期望requires_grad=True + ``` + 如果代码太长,请将可执行代码放到[AIStudio](https://aistudio.baidu.com/aistudio/index)中并将项目设置为公开(或者放到github gist上),请在项目中描述清楚bug复现步骤,在issue中描述期望结果与实际结果。 + 如果你报告的是一个报错信息,请将完整回溯的报错贴在这里,并使用 ` ```三引号块``` `展示错误信息。 + + + placeholder: | + 请清晰简洁的描述这个bug。A clear and concise description of what the bug is. + + ```python + # 最小可复现代码。 Sample code to reproduce the problem. + ``` + + ```shell + 带有完整回溯的报错信息。 The error message you got, with the full traceback. + ``` + validations: + required: true + +- type: textarea + id: others + attributes: + label: 其他补充信息 Additional Supplementary Information + description: | + 如果你还有其他需要补充的内容,请写在这里。 + If you have anything else to add, please write it here. + validations: + required: false + +- type: markdown + attributes: + value: > + 感谢你的贡献 🎉!Thanks for your contribution 🎉! diff --git a/.github/ISSUE_TEMPLATE/2_feature-request.yml b/.github/ISSUE_TEMPLATE/2_feature-request.yml new file mode 100644 index 00000000000..e9dd3465d17 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_feature-request.yml @@ -0,0 +1,37 @@ +name: 🚀 新需求 Feature Request +description: 提交一个你对Paddle的新需求。 Submit a request for a new Paddle feature. +labels: [type/feature-request, status/new-issue] + +body: +- type: markdown + attributes: + value: > + #### 你可以在这里提出你对Paddle框架的新需求,包括但不限于:功能或模型缺失、功能不全或无法使用、精度/性能不符合预期等。 + + #### You could submit a request for a new Paddle feature here, including but not limited to: new features or models, incomplete or unusable features, accuracy/performance not as expected, etc. + +- type: textarea + id: description + attributes: + label: 需求描述 Feature Description + description: | + 请尽可能包含任务目标、需求场景、功能描述等信息,全面的信息有利于我们准确评估你的需求。 + Please include as much information as possible, such as mission objectives, requirement scenarios, functional descriptions, etc. Comprehensive information will help us accurately assess your feature request. + value: "任务目标(请描述你正在做的项目是什么,如模型、论文、项目是什么?);
需求场景(请描述你的项目中为什么需要用此功能);
功能描述(请简单描述或设计这个功能)" + validations: + required: true + +- type: textarea + id: alternatives + attributes: + label: 替代实现 Alternatives + description: | + 如果你考虑过的任何替代解决方案或功能,请简要描述下,我们会综合评估。 + A description of any alternative solutions or features you've considered, if any. + validations: + required: false + +- type: markdown + attributes: + value: > + 感谢你的贡献 🎉!Thanks for your contribution 🎉! diff --git a/.github/ISSUE_TEMPLATE/3_build-installation-issue.yml b/.github/ISSUE_TEMPLATE/3_build-installation-issue.yml new file mode 100644 index 00000000000..2786175af6d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3_build-installation-issue.yml @@ -0,0 +1,65 @@ +name: 🗂 安装 Build/Installation Issue +description: 报告一个安装问题。 Report an issue related to build or install Paddle. +labels: [type/build, status/new-issue] + +body: +- type: markdown + attributes: + value: > + #### 安装请参考[官网文档](https://www.paddlepaddle.org.cn/install/quick?docurl=/documentation/docs/zh/develop/install/pip/linux-pip.html),若未能解决你的问题,你可以在这里提issue。 + + #### Before submitting a Build/Installation Issue, please make sure you have visited the [official website](https://www.paddlepaddle.org.cn/documentation/docs/en/install/index_en.html). + +- type: textarea + id: error + attributes: + label: 问题描述 Issue Description + description: | + 请详细描述你的问题,同步贴出报错信息、日志/代码关键片段、复现步骤,以便我们快速排查问题。 + Please describe your problem in detail, and synchronously post the error message, key log/code snippet, and reproduction steps, so that we can quickly troubleshoot the problem. + validations: + required: true + +- type: textarea + id: environment + attributes: + label: 版本&环境信息 Version & Environment Information + description: | + 请参考以下命令运行脚本[summary_env.py](https://github.com/PaddlePaddle/Paddle/blob/develop/tools/summary_env.py)获取版本&环境信息,并将输出拷贝在这里。 + Please run the following and paste the output below. + ```shell + wget https://raw.githubusercontent.com/PaddlePaddle/Paddle/develop/tools/summary_env.py + python3 -m pip install distro + python3 summary_env.py + ``` + 若运行脚本出现问题,请在issue中说明,并提供以下信息: + 1. PaddlePaddle版本:请提供你的PaddlePaddle版本号(如2.0.0)或CommitID。 + 2. CPU(可选):请提供CPU型号,MKL/OpenBlas/MKLDNN/等数学库的使用情况,是否支持AVX指令集。 + 3. GPU:请提供GPU型号,CUDA(如cuda10.2)和CUDNN版本号(如cudnn7.6.5)。 + 4. 系统环境:请说明系统类型、版本(如Mac OS 10.14)。 + 5. Python版本(如python 3.7)。 + 6. (可选)若安装过程遇到问题,请提供安装方式(pip/conda/docker/源码编译)和相应的安装命令。 + 7. (可选)若使用paddle过程中,遇到了无法使用gpu相关问题,请在命令行中键入`nvidia-smi`和`nvcc -V`,提供这两个命令输出的截图。 + 8. (可选)若使用特殊硬件,请单独注明。 + + + placeholder: | + **************************************** + Paddle version: + Paddle With CUDA: + + OS: + Python version: + + CUDA version: + cuDNN version: + Nvidia driver version: + **************************************** + validations: + required: true + + +- type: markdown + attributes: + value: > + 感谢你的贡献 🎉!Thanks for your contribution 🎉! diff --git a/.github/ISSUE_TEMPLATE/4_documentation-issue.yml b/.github/ISSUE_TEMPLATE/4_documentation-issue.yml new file mode 100644 index 00000000000..936ed3d92e8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4_documentation-issue.yml @@ -0,0 +1,39 @@ +name: 📚 文档 Documentation Issue +description: 反馈一个官网文档错误。 Report an issue related to https://www.paddlepaddle.org.cn/. +labels: [type/docs, status/new-issue] + +body: +- type: markdown + attributes: + value: > + #### 请确认反馈的问题来自PaddlePaddle官网文档:https://www.paddlepaddle.org.cn/ 。 + + #### Before submitting a Documentation Issue, Please make sure that issue is related to https://www.paddlepaddle.org.cn/. + +- type: textarea + id: link + attributes: + label: 文档链接&描述 Document Links & Description + description: | + 请说明有问题的文档链接以及该文档存在的问题。 + Please fill in the link to the document and describe the question. + validations: + required: true + + +- type: textarea + id: error + attributes: + label: 请提出你的建议 Please give your suggestion + description: | + 请告诉我们,你希望如何改进这个文档。或者你可以提个PR修复这个问题。[教程参考](https://github.com/PaddlePaddle/docs/wiki#%E8%B4%A1%E7%8C%AE%E6%96%87%E6%A1%A3) + Please tell us how you would like to improve this document. Or you can submit a PR to fix this problem. + + validations: + required: false + +- type: markdown + attributes: + value: > + 感谢你的贡献 🎉!Thanks for your contribution 🎉! + diff --git a/.github/ISSUE_TEMPLATE/5_ask-a-question.yml b/.github/ISSUE_TEMPLATE/5_ask-a-question.yml new file mode 100644 index 00000000000..158918946f3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/5_ask-a-question.yml @@ -0,0 +1,33 @@ +name: 🙋🏼‍♀️🙋🏻‍♂️提问 Ask a Question +description: 提出一个使用/咨询问题。 Ask a usage or consultation question. +labels: [type/question, status/new-issue] + +body: +- type: markdown + attributes: + value: > + #### 你可以在这里提出一个使用/咨询问题,提问之前请确保: + + - 1)已经百度/谷歌搜索过你的问题,但是没有找到解答; + + - 2)已经在官网查询过[API文档](https://www.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html)与[FAQ](https://www.paddlepaddle.org.cn/documentation/docs/zh/faq/index_cn.html),但是没有找到解答; + + - 3)已经在[历史issue](https://github.com/PaddlePaddle/Paddle/issues)中搜索过,没有找到同类issue或issue未被解答。 + + + #### You could ask a usage or consultation question here, before your start, please make sure: + + - 1) You have searched your question on Baidu/Google, but found no answer; + + - 2) You have checked the [API documentation](https://www.paddlepaddle.org.cn/documentation/docs/en/api/index_en.html), but found no answer; + + - 3) You have searched [the existing and past issues](https://github.com/PaddlePaddle/Paddle/issues), but found no similar issue or the issue has not been answered. + + + +- type: textarea + id: question + attributes: + label: 请提出你的问题 Please ask your question + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/6_others.yml b/.github/ISSUE_TEMPLATE/6_others.yml new file mode 100644 index 00000000000..e8f4a9c2329 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/6_others.yml @@ -0,0 +1,26 @@ +name: 🧩 其他 Others +description: 提出其他问题。 Report any other non-support related issues. +labels: [type/others, status/new-issue] + +body: +- type: markdown + attributes: + value: > + #### 你可以在这里提出任何前面几类模板不适用的问题,包括但不限于:优化性建议、框架使用体验反馈、版本兼容性问题、报错信息不清楚等。 + + #### You can report any issues that are not applicable to the previous types of templates, including but not limited to: enhancement suggestions, feedback on the use of the framework, version compatibility issues, unclear error information, etc. + +- type: textarea + id: others + attributes: + label: 问题描述 Please describe your issue + validations: + required: true + +- type: markdown + attributes: + value: > + 感谢你的贡献 🎉! Thanks for your contribution 🎉! + + + -- GitLab