From bdb85d61159df16b6eee96ef0fd4b4ebe644793d Mon Sep 17 00:00:00 2001 From: Jennifer <42981373+jennijuju@users.noreply.github.com> Date: Sat, 6 Feb 2021 16:23:25 -0500 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug-report.md | 31 +++++++++++++ .github/ISSUE_TEMPLATE/deal-making-issues.md | 46 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++ .github/ISSUE_TEMPLATE/mining-issues.md | 34 ++++++++++++++ .github/ISSUE_TEMPLATE/proving-issues.md | 48 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/sealingfailed.md | 21 +++++---- 6 files changed, 192 insertions(+), 8 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/deal-making-issues.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/mining-issues.md create mode 100644 .github/ISSUE_TEMPLATE/proving-issues.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 000000000..ca5da6436 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,31 @@ +--- +name: Bug Report +about: Create a report to help us improve +title: "[BUG] " +labels: hint/needs-triaging, kind/bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. +(If you are not sure what the bug is, try to figure it out via a [discussion](https://github.com/filecoin-project/lotus/discussions/new) first! + +**Version (run `lotus version`):** + +**To Reproduce** +Steps to reproduce the behavior: +1. Run '...' +2. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Logs** +Provide daemon/miner/worker and goroutines(if available) for troubleshooting. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/deal-making-issues.md b/.github/ISSUE_TEMPLATE/deal-making-issues.md new file mode 100644 index 000000000..9df286cd8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/deal-making-issues.md @@ -0,0 +1,46 @@ +--- +name: Deal Making Issues +about: Create a report for help with deal making failures. +title: "[Deal Making Issue]" +labels: hint/needs-triaging, area/markets +assignees: '' + +--- + +Please provide all the information requested here to help us troubleshoot "deal making failed" issues. +If the information requested is missing, we will probably have to just ask you to provide it anyway, +before we can help debug. + +**Basic Information** +Including information like, Are you the client or the miner? Is this a storage deal or a retrieval deal? Is it an offline deal? + +**Describe the problem** + +A brief description of the problem you encountered while deal making. + +**Version** + +The output of `lotus --version`. + +**Setup** + +You miner(if applicable) and daemon setup. + +**Commands** + +Commands you ran. + +**Deal status** + +The output of `lotus client` or `lotus-miner storage-deals|retrieval-deals|data-transfers` commands for the deal(s) in question. + +**Lotus daemon and miner logs** + +Please go through the logs of your daemon and miner(if applicable), and include screenshots of any error/warning-like messages you find. + +Alternatively please upload full log files and share a link here + +** Code modifications ** + +If you have modified parts of lotus, please describe which areas were modified, +and the scope of those modifications diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..0803a6db8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[Feature Request]" +labels: hint/needs-triaging +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/mining-issues.md b/.github/ISSUE_TEMPLATE/mining-issues.md new file mode 100644 index 000000000..9297982f1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/mining-issues.md @@ -0,0 +1,34 @@ +--- +name: Mining Issues +about: Create a report for help with mining failures. +title: "[Mining Issue]" +labels: hint/needs-triaging, area/mining +assignees: '' + +--- + +Please provide all the information requested here to help us troubleshoot "mining/WinningPoSt failed" issues. +If the information requested is missing, we will probably have to just ask you to provide it anyway, +before we can help debug. + +**Describe the problem** +A brief description of the problem you encountered while mining new blocks. + +**Version** + +The output of `lotus --version`. + +**Setup** + +You miner and daemon setup. + +**Lotus daemon and miner logs** + +Please go through the logs of your daemon and miner, and include screenshots of any error/warning-like messages you find, highlighting the one has "winning post" in it. + +Alternatively please upload full log files and share a link here + +** Code modifications ** + +If you have modified parts of lotus, please describe which areas were modified, +and the scope of those modifications diff --git a/.github/ISSUE_TEMPLATE/proving-issues.md b/.github/ISSUE_TEMPLATE/proving-issues.md new file mode 100644 index 000000000..63eceb751 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/proving-issues.md @@ -0,0 +1,48 @@ +--- +name: Proving Issues +about: Create a report for help with proving failures. +title: "[Proving Issue]" +labels: area/proving, hint/needs-triaging +assignees: '' + +--- + +Please provide all the information requested here to help us troubleshoot "proving/wdpost failed" issues. +If the information requested is missing, we will probably have to just ask you to provide it anyway, +before we can help debug. + +**Describe the problem** +A brief description of the problem you encountered while proving the storage. + +**Version** + +The output of `lotus --version`. + +**Setup** + +You miner, worker and daemon setup. + +**Commands** + +Commands you ran. + +**Proving status** + +The output of `lotus-miner proving` info. + +**Lotus miner logs** + +Please go through the logs of your miner, and include screenshots of any error-like messages you find, highlighting the one has "window post" in it. + +Alternatively please upload full log files and share a link here + +**Lotus miner diagnostic info** + +Please collect the following diagnostic information, and share a link here + +* lotus-miner diagnostic info `lotus-miner info all > allinfo` + +** Code modifications ** + +If you have modified parts of lotus, please describe which areas were modified, +and the scope of those modifications diff --git a/.github/ISSUE_TEMPLATE/sealingfailed.md b/.github/ISSUE_TEMPLATE/sealingfailed.md index ae14c3262..ab7e3dcf0 100644 --- a/.github/ISSUE_TEMPLATE/sealingfailed.md +++ b/.github/ISSUE_TEMPLATE/sealingfailed.md @@ -1,8 +1,8 @@ --- name: Sealing Issues about: Create a report for help with sealing (commit) failures. -title: '' -labels: 'sealing' +title: "[Sealing Issue]" +labels: hint/needs-triaging, area/sealing assignees: '' --- @@ -12,10 +12,19 @@ If the information requested is missing, we will probably have to just ask you t before we can help debug. **Describe the problem** +A brief description of the problem you encountered while sealing a sector. -A brief description of the problem you encountered while proving (sealing) a sector. +**Version** -Including what commands you ran, and a description of your setup, is very helpful. +The output of `lotus --version`. + +**Setup** + +You miner, worker and daemon setup. + +**Commands** + +Commands you ran. **Sectors status** @@ -37,7 +46,3 @@ Please collect the following diagnostic information, and share a link here If you have modified parts of lotus, please describe which areas were modified, and the scope of those modifications - -**Version** - -The output of `lotus --version`.