diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..3a7803fe2f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,102 @@ +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/venus/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 [venus forum](https://github.com/filecoin-project/venus/discussions). + required: true + - label: This is **not** a new feature request. If it is, please file a [feature request](https://github.com/filecoin-project/venus/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/venus/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/venus/issues) and the [venus forum](https://github.com/filecoin-project/venus/discussions), and there is no existing related issue or discussion. + required: true + - label: I am running the [`latest release`](https://github.com/filecoin-project/venus/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 venus. + required: false +- type: checkboxes + attributes: + label: Venus component + description: Please select the venus component you are filing a bug for + options: + - label: venus daemon - chain sync + required: false + - label: venus auth - authentication + required: false + - label: venus gateway - chain service gateway + required: false + - label: venus miner - mining and block production + required: false + - label: venus sealer/worker - sealing + required: false + - label: venus sealer - proving(WindowPoSt) + required: false + - label: venus market - storage deal + required: false + - label: venus market - retrieval deal + required: false + - label: venus market - data transfer + required: false + - label: venus light-weight client + required: false + - label: venus JSON-RPC API + required: false + - label: venus messager - message management (mpool) + required: false + - label: Other + required: false +- type: textarea + id: version + attributes: + label: Venus Version + render: text + description: Enter the output of `./venus version` and `./venus-sealer -v` if applicable. + placeholder: | + e.g. + Daemon: "Commit": "v1.0.4 c816de06debd1874bc0b2c9cad10a80e8f388681" + Local: venus-sealer version 1.2.6+git.eb586f1.dirty + validations: + required: 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 doing 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 `./venus-sealer sectors status --log ` for the failed sector(s). + * For proving issues, include the output of `./venus-sealer proving` info. + * For deal making issues, include the output of `./market-client list-deals -v` and/or `./venus-market storage-deals|retrieval-deals|data-transfers list [-v]` commands for the deal(s) in question. + validations: + required: true +- type: textarea + id: extraInfo + attributes: + label: Logging Information + render: text + description: | + Please provide debug logs of the problem, remember you can get set log 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. + 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 '...' + ... + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 0000000000..73c3430d7d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -0,0 +1,56 @@ +name: Enhancement +description: Suggest an improvement to an existing venus 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/venus/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 venus forum](https://github.com/filecoin-project/venus/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: checkboxes + attributes: + label: Venus component + description: Please select the venus component you are filing an improvement request for + options: + - label: venus daemon - [chain service] chain sync + required: false + - label: venus auth - [chain service] authentication + required: false + - label: venus messager - [chain service] message management (mpool) + required: false + - label: venus gateway - [chain service] gateway + required: false + - label: venus miner - [chain service] mining and block production + required: false + - label: venus sealer/worker - sealing + required: false + - label: venus sealer - proving (WindowPoSt) + required: false + - label: venus market - storage deal + required: false + - label: venus market - retrieval deal + required: false + - label: venus market - data transfer + required: false + - label: venus light-weight client + required: false + - label: venus JSON-RPC API + required: false + - label: Other + required: false +- type: textarea + id: request + attributes: + 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 venus... However, as a storage provider, I'd like... + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000000..d1932a9d2a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,75 @@ +name: Feature request +description: Suggest an idea for venus +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 venus forum](https://github.com/filecoin-project/venus/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: checkboxes + attributes: + label: Venus component + description: Please select the venus component you are filing a new feature request for + options: + - label: venus daemon - [chain service] chain sync + required: false + - label: venus auth - [chain service] authentication + required: false + - label: venus messager - [chain service] message management (mpool) + required: false + - label: venus gateway - [chain service] gateway + required: false + - label: venus miner - [chain service] mining and block production + required: false + - label: venus sealer/worker - sealing + required: false + - label: venus sealer - proving (WindowPoSt) + required: false + - label: venus market - storage deal + required: false + - label: venus market - retrieval deal + required: false + - label: venus market - data transfer + required: false + - label: venus light-weight client + required: false + - label: venus JSON-RPC API + required: false + - label: Other + required: false +- 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