From 816ee0b0043be48ea5a8f067667218177eafa9d3 Mon Sep 17 00:00:00 2001 From: Jennifer Wang Date: Fri, 23 Jul 2021 18:13:34 -0400 Subject: [PATCH] Update issue templates and add templates for M1 --- .../{bug-report.yml => bug_report.yml} | 8 +- .github/ISSUE_TEMPLATE/enhancement.yml | 4 +- .github/ISSUE_TEMPLATE/m1_bug_report_deal.yml | 89 +++++++++++++++++++ .../ISSUE_TEMPLATE/m1_bug_report_non_deal.yml | 81 +++++++++++++++++ 4 files changed, 176 insertions(+), 6 deletions(-) rename .github/ISSUE_TEMPLATE/{bug-report.yml => bug_report.yml} (94%) create mode 100644 .github/ISSUE_TEMPLATE/m1_bug_report_deal.yml create mode 100644 .github/ISSUE_TEMPLATE/m1_bug_report_non_deal.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml similarity index 94% rename from .github/ISSUE_TEMPLATE/bug-report.yml rename to .github/ISSUE_TEMPLATE/bug_report.yml index 7f9ec9d03..7876715e2 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -11,16 +11,16 @@ body: 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. + - 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=need%2Ftriage%2Ckind%2Ffeature&template=feature_request.yml) 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. + - 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=need%2Ftriage%2Ckind%2Fenhancement&template=enhancement.yml) 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 + required: false - type: dropdown id: component-and-area validations: @@ -89,4 +89,4 @@ body: ... render: bash validations: - required: true \ No newline at end of file + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml index 59738ef4b..7320fa5c5 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.yml +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -9,7 +9,7 @@ body: 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. + - 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=need%2Ftriage%2Ckind%2Ffeature&template=feature_request.yml) 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 @@ -36,7 +36,7 @@ body: - type: textarea id: request attributes: - label: What is the motivation behind improvement proposal? What's problem with the existing feature? Please describe. + label: Improvement Suggestion 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: diff --git a/.github/ISSUE_TEMPLATE/m1_bug_report_deal.yml b/.github/ISSUE_TEMPLATE/m1_bug_report_deal.yml new file mode 100644 index 000000000..d40609174 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/m1_bug_report_deal.yml @@ -0,0 +1,89 @@ +name: "M1 Bug Report For Deal Making" +description: "File a bug report around deal making for the M1 releases" +labels: [need/triage, kind/bug, M1-release] +body: +- type: checkboxes + id: checklist + attributes: + label: Checklist + description: Please check off the following boxes before continuing to file a bug report! + options: + - 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: I **am** reporting a bug w.r.t one of the [M1 tags](https://github.com/filecoin-project/lotus/discussions/6852#discussioncomment-1043951). If not, choose another issue option [here](https://github.com/filecoin-project/lotus/issues/new/choose). + required: true + - label: I have my log level set as instructed [here](https://github.com/filecoin-project/lotus/discussions/6852#discussioncomment-1043678) and have logs available for troubleshooting. + required: true + - label: The deal is coming from one of the M1 clients(communitcated in the coordination slack channel). + 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 +- type: dropdown + id: lotus-componets + validations: + required: true + attributes: + label: Lotus Component + description: Please select the lotus component you are filing a bug for + options: + - lotus miner market subsystem - storage deal + - lotus miner market subsystem - retrieval deal + - lotus miner - storage deal + - lotus miner - retrieval deal +- type: textarea + id: version + attributes: + label: Lotus Tag and Version + description: Enter the lotus tag, output of `lotus version` and `lotus-miner version`. + 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). + * What is the expected behaviour? + render: bash + validations: + required: true +- type: textarea + id: deal-status + attributes: + label: Deal Status + description: What's the status of the deal? + placeholder: | + Please share the output of `lotus-miner storage-deals|retrieval-deals list [-v]` commands for the deal(s) in question. + validations: + required: true +- type: textarea + id: data-transfer-status + attributes: + label: Data Transfer Status + description: What's the status of the data transfer? + placeholder: | + Please share the output of `lotus-miner data-transfers list -v` commands for the deal(s) in question. + validations: + required: true +- type: textarea + id: logging + attributes: + label: Logging Information + description: Please link to the whole of the miner logs on your side of the transaction. You can upload the logs to a [gist](https://gist.github.com). + validations: + required: true +- type: textarea + id: RepoSteps + attributes: + label: Repo Steps (optional) + description: "Steps to reproduce the behavior" + value: | + 1. Run '...' + 2. Do '...' + 3. See error '...' + ... + render: bash + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/m1_bug_report_non_deal.yml b/.github/ISSUE_TEMPLATE/m1_bug_report_non_deal.yml new file mode 100644 index 000000000..86ab6ffd3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/m1_bug_report_non_deal.yml @@ -0,0 +1,81 @@ +name: "M1 Bug Report For Non Deal Making Issue" +description: "File a bug report around non deal making issue for the M1 releases" +labels: [need/triage, kind/bug, M1-release] +body: +- type: checkboxes + id: checklist + attributes: + label: Checklist + description: Please check off the following boxes before continuing to file a bug report! + options: + - 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: I **am** reporting a bug w.r.t one of the [M1 tags](https://github.com/filecoin-project/lotus/discussions/6852#discussioncomment-1043951). If not, choose another issue option [here](https://github.com/filecoin-project/lotus/issues/new/choose). + required: true + - label: I am **not** reporting a bug around deal making. If yes, choose `M1 Bug Report For Deal Making` option [here](https://github.com/filecoin-project/lotus/issues/new/choose) + 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 +- type: dropdown + 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 - chain sync **with** splitstore enabled + - lotus daemon - chain sync **without** splitstore enabled + - lotus miner - mining and block production + - lotus miner/worker - sealing + - lotus miner - proving(WindowPoSt) + - lotus client + - lotus JSON-RPC API + - lotus message management (mpool) + - Other +- type: textarea + id: version + attributes: + label: Lotus Tag and Version + description: Enter the lotus tag, output of `lotus version` and `lotus-miner version`. + 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). + * 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. + 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: false \ No newline at end of file