diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 122fe3a0..8ea4d2b0 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,62 +1,53 @@ --- name: Bug report about: Submit a bug report -title: "[Bug] Report title" -labels: '' -assignees: '' - ---- - - - -### Description - -A clear and concise description of the bug/issue. - -### Steps to reproduce and logs - -Please try to provide a minimal example to reproduce the bug/issue. -Error messages and logs are also helpful. - - - -``` -Paste the terminal error here -``` - -### Setup information - - -Basic information -- skrl version: [e.g. 1.0.0. Can be obtained by `pip show skrl`] -- Python version: [e.g. 3.10] -- OS: [e.g. Ubuntu 20.04] - - -ML frameworks/libraries -- PyTorch version: [e.g. 2.0.0. Can be obtained by `pip show torch`] -- JAX version: [e.g. 0.4.0. Can be obtained by `pip show jax`] -- Flax version: [e.g. 0.6.0. Can be obtained by `pip show flax`] -- Optax version: [e.g. 0.1.0. Can be obtained by `pip show optax`] - - -Environments interfaces -- Gym / Gymnasium version: [e.g. 0.23.0 / 0.28.0. Can be obtained by `pip show gym gymnasium`] -- NVIDIA OmniIsaacGymEnvs (OIGE) version: [e.g. 2022.2.0.0. Can be obtained by `./python.sh -m pip show omniisaacgymenvs`] -- NVIDIA Isaac Orbit version: [e.g. 0.2.0. Can be obtained by `orbit -p -m pip show omni-isaac-orbit_envs`] -- NVIDIA IsaacGymEnvs (preview) version: [e.g. 1.3.0. Can be obtained by `pip show isaacgymenvs`] -- - -### Additional information - -Please provide any additional information that may be helpful in resolving the bug - -### Checklist - -I have checked that... -- [ ] there is no similar issue in the repository -- [ ] the issue is not solved in the skrl's docs troubleshooting section - +labels: +- bug + +body: +- type: markdown + attributes: + value: > + ## Your help in making skrl better is greatly appreciated! + + * Please ensure that the issue hasn't already been reported by using the [issue search](https://github.com/Toni-SM/skrl/search?q=is%3Aissue&type=issues). + + * The issue (and its solution) is not listed in the skrl documentation's [troubleshooting](https://skrl.readthedocs.io/en/latest/intro/installation.html#known-issues-and-troubleshooting) section. + + * For questions, please consider [open a discussion](https://github.com/Toni-SM/skrl/discussions). +
+- type: textarea + attributes: + label: Description + description: >- + A clear and concise description of the bug/issue. Try to provide a minimal example to reproduce it (error/log messages are also helpful). + placeholder: | + Markdown formatting might be applied to the text. + + ```python + # use triple backticks for code-blocks or error/log messages + ``` + validations: + required: true +- type: dropdown + attributes: + label: What skrl version are you using? + description: The skrl version can be obtained with the command `pip show skrl`. + options: + - unknown + - 1.0.0 + - 1.0.0-rc2 + - 1.0.0-rc1 + - 0.10.2 or 0.10.1 + - 0.10.0 or earlier + validations: + required: true +- type: input + attributes: + label: What ML framework/library version are you using? + description: The version can be obtained with the command `pip show torch` or `pip show jax flax optax`. + placeholder: PyTorch version, JAX/Flax/Optax version, etc. +- type: input + attributes: + label: Additional system information + placeholder: Python version, OS (Linux/Windows/Mac/WSL), etc. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..a0686648 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Question + url: https://github.com/Toni-SM/skrl/discussions + about: Please ask questions on the Discussions tab diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index a0174914..00000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -name: Question -about: To ask a question go to the Discussions tab! -title: To ask a question go to the Discussions tab! -labels: '' -assignees: '' - ---- - -Please, don't create a new issue for a question. -Instead, ask your question on the Discussions tab. - -Discussions: https://github.com/Toni-SM/skrl/discussions