From bda25dd6f28369c0b223b1285de580602d834165 Mon Sep 17 00:00:00 2001 From: Jennifer Wang Date: Tue, 20 Jul 2021 01:11:29 -0400 Subject: [PATCH 1/2] Use forms for creating lotus issues. --- .github/ISSUE_TEMPLATE/bug-report.md | 33 ------ .github/ISSUE_TEMPLATE/bug-report.yml | 112 +++++++++++++++++++ .github/ISSUE_TEMPLATE/deal-making-issues.md | 49 -------- .github/ISSUE_TEMPLATE/enhancement.yml | 70 ++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ---- .github/ISSUE_TEMPLATE/feature_request.yml | 75 +++++++++++++ .github/ISSUE_TEMPLATE/mining-issues.md | 35 ------ .github/ISSUE_TEMPLATE/proving-issues.md | 46 -------- .github/ISSUE_TEMPLATE/sealing-issues.md | 50 --------- 9 files changed, 257 insertions(+), 233 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/deal-making-issues.md create mode 100644 .github/ISSUE_TEMPLATE/enhancement.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/mining-issues.md delete mode 100644 .github/ISSUE_TEMPLATE/proving-issues.md delete mode 100644 .github/ISSUE_TEMPLATE/sealing-issues.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 23c7640b7..000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Bug Report -about: Create a report to help us improve -title: "[BUG] " -labels: hint/needs-triaging, kind/bug -assignees: '' - ---- - -> Note: For security-related bugs/issues, please follow the [security policy](https://github.com/filecoin-project/lotus/security/policy). - -**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 logs, 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/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..3ff61fd17 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,112 @@ +name: "Bug Report" +description: "File a bug report to help us improve" +labels: [need/triage, kind/bug] +body: +- type: checkboxes + attributes: + label: Checklist + description: Please check off the following boxes before continuing to file a bug report! + options: + - label: This is **not** a security-related bug/issue. If it is, please follow please follow the [security policy](https://github.com/filecoin-project/lotus/security/policy). + required: true + - label: This is **not** a question or a support request. If you have any lotus related questions, please ask in the [lotus forum](https://github.com/filecoin-project/lotus/discussions). + required: true + - label: This is **not** a new feature request. If it is, please file a [feature request](https://github.com/filecoin-project/lotus/issues/new?assignees=&labels=hint%2Fneeds-triaging&template=feature_request.yaml) instead. + required: true + - label: This is **not** an enhancement request. If it is, please file a [improvement suggestion](https://github.com/filecoin-project/lotus/issues/new?assignees=&labels=hint%2Fneeds-triaging&template=enhancement.yaml) instead. + required: true + - label: I **have** searched on the [issue tracker](https://github.com/filecoin-project/lotus/issues) and the [lotus forum](https://github.com/filecoin-project/lotus/discussions), and there is no existing related issue or discussion. + required: true + - label: I am running the [`Latest release`](https://github.com/filecoin-project/lotus/releases), or the most recent RC(release canadiate) for the upcoming release or the dev branch(master), or have an issue updating to any of these. + required: true + - label: I did not make any code changes to lotus. + required: true +- type: dropdown + id: component + validations: + required: true + attributes: + label: Lotus component + description: Please select the lotus component you are filing a bug for + options: + - lotus daemon + - lotus miner/lotus worker + - lotus client + - lotus market + - lotus JSON-RPC API + - Other +- type: dropdown + id: area + validations: + required: true + attributes: + label: Area + description: Please select the process you are having issue with + options: + - syncing + - sealing + - mining (WinningPoSt) + - proving (WindowPoSt) + - deal making + - api call + - message management (mpool) + - Other +- type: textarea + id: version + attributes: + label: Lotus Version + description: Enter the output of `lotus version` and `lotus-miner version` if applicable. + placeholder: | + e.g. + Daemon:1.11.0-rc2+debug+git.0519cd371.dirty+api1.3.0 + Local: lotus version 1.11.0-rc2+debug+git.0519cd371.dirty + validations: + reuiqred: true +- type: textarea + id: Description + attributes: + label: Describe the Bug + description: | + This is where you get to tell us what went wrong, when doing so, please try to provide a clear and concise description of the bug with all related information: + * What you were doding when you experienced the bug? + * Any *error* messages you saw, *where* you saw them, and what you believe may have caused them (if you have any ideas). + * For sealing issues, include the output of `lotus-miner sectors status --log ` for the failed sector(s). + * For proving issues, include the output of `lotus-miner proving` info. + * For deal making issues, include the output of `lotus client list-deals -v` and/or `lotus-miner storage-deals|retrieval-deals|data-transfers list [-v]` commands for the deal(s) in question. + render: bash + validations: + required: true +- type: textarea + id: extraInfo + attributes: + label: Logging Information + description: | + Please provide debug logs of the problem, remember you can get set log level control for: + * lotus: use `lotus log list` to get all log systems available and set level by `lotus log set-level`. An example can be found [here](https://docs.filecoin.io/get-started/lotus/configuration-and-advanced-usage/#log-level-control). + * lotus-miner:`lotus-miner log list` to get all log systems available and set level by `lotus-miner log set-level + If you don't provide detailed logs when you raise the issue it will almost certainly be the first request I make before furthur diagnosing the problem. + render: bash + validations: + required: true +- type: textarea + id: RepoSteps + attributes: + label: Repo Steps + description: "Steps to reproduce the behavior" + value: | + 1. Run '...' + 2. Do '...' + 3. See error '...' + ... + render: bash + validations: + required: true +- type: textarea + id: expected + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + render: bash + placeholder: "By doing... I expect..." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/deal-making-issues.md b/.github/ISSUE_TEMPLATE/deal-making-issues.md deleted file mode 100644 index bec800cb7..000000000 --- a/.github/ISSUE_TEMPLATE/deal-making-issues.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -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: '' - ---- - -> Note: For security-related bugs/issues, please follow the [security policy](https://github.com/filecoin-project/lotus/security/policy). - -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 trying to make a deal. - -**Version** - -The output of `lotus --version`. - -**Setup** - -You miner(if applicable) and daemon setup, i.e: What hardware do you use, how much ram and etc. - -**To Reproduce** - Steps to reproduce the behavior: - 1. Run '...' - 2. See error - -**Deal status** - -The output of `lotus client list-deals -v` and/or `lotus-miner storage-deals|retrieval-deals|data-transfers list [-v]` 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/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 000000000..57d0c18b3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -0,0 +1,70 @@ +name: Enhancement +description: Suggest an improvement to an existing lotus feature. +labels: [need/triage, kind/enhancement] +body: +- type: checkboxes + attributes: + label: Checklist + description: Please check off the following boxes before continuing to create an improvement suggestion! + options: + - label: This is **not** a new feature or an enhancement to the Filecoin protocol. If it is, please open an [FIP issue](https://github.com/filecoin-project/FIPs/blob/master/FIPS/fip-0001.md). + required: true + - label: This is **not** a new feature request. If it is, please file a [feature request](https://github.com/filecoin-project/lotus/issues/new?assignees=&labels=hint%2Fneeds-triaging&template=feature_request.yaml) instead. + required: true + - label: This is **not** brainstorming ideas. If you have an idea you'd like to discuss, please open a new discussion on [the lotus forum](https://github.com/filecoin-project/lotus/discussions/categories/ideas) and select the category as `Ideas`. + required: true + - label: I **have** a specific, actionable, and well motivated improvement to propose. + required: true +- type: dropdown + id: component + validations: + required: true + attributes: + label: Lotus component + description: Please select the lotus component you are propoing improvement for + options: + - lotus daemon + - lotus miner/lotus worker + - lotus client + - lotus market + - lotus JSON-RPC API + - Other +- type: dropdown + id: area + validations: + required: true + attributes: + label: Area + description: Please select the area + options: + - syncing + - sealing + - mining (WinningPoSt) + - proving (WindowPoSt) + - deal making + - api call + - message management (mpool) + - Other +- type: textarea + id: request + attributes: + label: What is the motivation behind improvement proposal? What's problem with the existing feature? Please describe. + description: A clear and concise description of what the motivation or the current problem is and what is the suggested improvement? + placeholder: Ex. Currently lotus... However, as a storage provider, I'd like... + validations: + required: true +- type: textarea + id: alternates + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions you've considered. + validations: + required: false +- type: textarea + id: extra + attributes: + label: Additional context + description: Add any other context, design docs or screenshots about the feature request here. + validations: + required: false + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 0803a6db8..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -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/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..27132d53a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,75 @@ +name: Feature request +description: Suggest an idea for lotus +labels: [need/triage, kind/feature] +body: +- type: checkboxes + attributes: + label: Checklist + description: Please check off the following boxes before continuing to create a new feature request! + options: + - label: This is **not** a new feature or an enhancement to the Filecoin protocol. If it is, please open an [FIP issue](https://github.com/filecoin-project/FIPs/blob/master/FIPS/fip-0001.md). + required: true + - label: This is **not** brainstorming ideas. If you have an idea you'd like to discuss, please open a new discussion on [the lotus forum](https://github.com/filecoin-project/lotus/discussions/categories/ideas) and select the category as `Ideas`. + required: true + - label: I **have** a specific, actionable, and well motivated feature request to propose. + required: true +- type: dropdown + id: component + validations: + required: true + attributes: + label: Lotus component + description: Please select the lotus component you are requesting a new feature for + options: + - lotus daemon + - lotus miner/lotus worker + - lotus client + - lotus market + - lotus JSON-RPC API + - Other +- type: dropdown + id: area + validations: + required: true + attributes: + label: Area + description: Please select the area + options: + - syncing + - sealing + - mining (WinningPoSt) + - proving (WindowPoSt) + - deal making + - api call + - message management (mpool) + - Other +- type: textarea + id: request + attributes: + label: What is the motivation behind this feature request? Is your feature request related to a problem? Please describe. + description: A clear and concise description of what the motivation or the problem is. + placeholder: Ex. I'm always frustrated when [...] + validations: + required: true +- type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true +- type: textarea + id: alternates + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false +- type: textarea + id: extra + attributes: + label: Additional context + description: Add any other context, design docs or screenshots about the feature request here. + validations: + required: false + diff --git a/.github/ISSUE_TEMPLATE/mining-issues.md b/.github/ISSUE_TEMPLATE/mining-issues.md deleted file mode 100644 index 434e160d4..000000000 --- a/.github/ISSUE_TEMPLATE/mining-issues.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Mining Issues -about: Create a report for help with mining failures. -title: "[Mining Issue]" -labels: hint/needs-triaging, area/mining -assignees: '' - ---- - -> Note: For security-related bugs/issues, please follow the [security policy](https://github.com/filecoin-project/lotus/security/policy). - -Please provide all the information requested here to help us troubleshoot "mining/WinningPoSt failed" issues. -If the information requested is missing, you may be asked you to provide it. - -**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, including what hardware do you use, your environment variable settings, how do you run your miner and worker, do you use GPU and etc. - -**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 deleted file mode 100644 index 6187d546e..000000000 --- a/.github/ISSUE_TEMPLATE/proving-issues.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -name: Proving Issues -about: Create a report for help with proving failures. -title: "[Proving Issue]" -labels: area/proving, hint/needs-triaging -assignees: '' - ---- - -> Note: For security-related bugs/issues, please follow the [security policy](https://github.com/filecoin-project/lotus/security/policy). - -Please provide all the information requested here to help us troubleshoot "proving/window PoSt 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 and daemon setup, including what hardware do you use, your environment variable settings, how do you run your miner and worker, do you use GPU and etc. - -**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.txt` - -** 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/sealing-issues.md b/.github/ISSUE_TEMPLATE/sealing-issues.md deleted file mode 100644 index 7511849d3..000000000 --- a/.github/ISSUE_TEMPLATE/sealing-issues.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -name: Sealing Issues -about: Create a report for help with sealing (commit) failures. -title: "[Sealing Issue]" -labels: hint/needs-triaging, area/sealing -assignees: '' - ---- - -> Note: For security-related bugs/issues, please follow the [security policy](https://github.com/filecoin-project/lotus/security/policy). - -Please provide all the information requested here to help us troubleshoot "commit 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 sealing a sector. - -**Version** - -The output of `lotus --version`. - -**Setup** - -You miner and daemon setup, including what hardware do you use, your environment variable settings, how do you run your miner and worker, do you use GPU and etc. - -**Commands** - -Commands you ran. - -**Sectors status** - -The output of `lotus-miner sectors status --log ` for the failed sector(s). - -**Lotus miner logs** - -Please go through the logs of your miner, and include screenshots of any error-like messages you find. - -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 From e41bc229e3d19144b33e33e08276823c1c93953d Mon Sep 17 00:00:00 2001 From: Jennifer Wang Date: Fri, 23 Jul 2021 00:26:48 -0400 Subject: [PATCH 2/2] Address the feedbacks --- .github/ISSUE_TEMPLATE/bug-report.yml | 40 +++++-------------- .github/ISSUE_TEMPLATE/enhancement.yml | 46 +++++----------------- .github/ISSUE_TEMPLATE/feature_request.yml | 32 +++++---------- 3 files changed, 30 insertions(+), 88 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 3ff61fd17..7f9ec9d03 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -22,34 +22,22 @@ body: - label: I did not make any code changes to lotus. required: true - type: dropdown - id: component + id: component-and-area validations: required: true attributes: label: Lotus component description: Please select the lotus component you are filing a bug for options: - - lotus daemon - - lotus miner/lotus worker + - lotus daemon - chain sync + - lotus miner - mining and block production + - lotus miner/worker - sealing + - lotus miner - proving(WindowPoSt) + - lotus miner/market - storage deal + - lotus miner/market - retrieval deal - lotus client - - lotus market - lotus JSON-RPC API - - Other -- type: dropdown - id: area - validations: - required: true - attributes: - label: Area - description: Please select the process you are having issue with - options: - - syncing - - sealing - - mining (WinningPoSt) - - proving (WindowPoSt) - - deal making - - api call - - message management (mpool) + - lotus message management (mpool) - Other - type: textarea id: version @@ -70,6 +58,7 @@ body: This is where you get to tell us what went wrong, when doing so, please try to provide a clear and concise description of the bug with all related information: * What you were doding when you experienced the bug? * Any *error* messages you saw, *where* you saw them, and what you believe may have caused them (if you have any ideas). + * What is the expected behaviour? * For sealing issues, include the output of `lotus-miner sectors status --log ` for the failed sector(s). * For proving issues, include the output of `lotus-miner proving` info. * For deal making issues, include the output of `lotus client list-deals -v` and/or `lotus-miner storage-deals|retrieval-deals|data-transfers list [-v]` commands for the deal(s) in question. @@ -100,13 +89,4 @@ body: ... render: bash validations: - required: true -- type: textarea - id: expected - attributes: - label: Expected Behavior - description: A clear and concise description of what you expected to happen. - render: bash - placeholder: "By doing... I expect..." - validations: - required: false + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml index 57d0c18b3..59738ef4b 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.yml +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -23,28 +23,16 @@ body: label: Lotus component description: Please select the lotus component you are propoing improvement for options: - - lotus daemon - - lotus miner/lotus worker - - lotus client - - lotus market - - lotus JSON-RPC API - - Other -- type: dropdown - id: area - validations: - required: true - attributes: - label: Area - description: Please select the area - options: - - syncing - - sealing - - mining (WinningPoSt) - - proving (WindowPoSt) - - deal making - - api call - - message management (mpool) - - Other + - lotus daemon - chain sync + - lotus miner - mining and block production + - lotus miner/worker - sealing + - lotus miner - proving(WindowPoSt) + - lotus miner/market - storage deal + - lotus miner/market - retrieval deal + - lotus client + - lotus JSON-RPC API + - lotus message management (mpool) + - Other - type: textarea id: request attributes: @@ -53,18 +41,4 @@ body: placeholder: Ex. Currently lotus... However, as a storage provider, I'd like... validations: required: true -- type: textarea - id: alternates - attributes: - label: Describe alternatives you've considered - description: A clear and concise description of any alternative solutions you've considered. - validations: - required: false -- type: textarea - id: extra - attributes: - label: Additional context - description: Add any other context, design docs or screenshots about the feature request here. - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 27132d53a..5cb39b0d5 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -21,28 +21,16 @@ body: label: Lotus component description: Please select the lotus component you are requesting a new feature for options: - - lotus daemon - - lotus miner/lotus worker - - lotus client - - lotus market - - lotus JSON-RPC API - - Other -- type: dropdown - id: area - validations: - required: true - attributes: - label: Area - description: Please select the area - options: - - syncing - - sealing - - mining (WinningPoSt) - - proving (WindowPoSt) - - deal making - - api call - - message management (mpool) - - Other + - lotus daemon - chain sync + - lotus miner - mining and block production + - lotus miner/worker - sealing + - lotus miner - proving(WindowPoSt) + - lotus miner/market - storage deal + - lotus miner/market - retrieval deal + - lotus client + - lotus JSON-RPC API + - lotus message management (mpool) + - Other - type: textarea id: request attributes: