Merge pull request DLR-RM#1 from RaikoPipe/fix_tests

Merged to master for convenience

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,71 @@
+name: "\U0001F41B Bug Report"
+description: Submit a bug report to help us improve Stable-Baselines3
+title: "[Bug]: bug title"
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email.
+        Please post your question on the [RL Discord](https://discord.com/invite/xhfNqQv), [Reddit](https://www.reddit.com/r/reinforcementlearning/) or [Stack Overflow](https://stackoverflow.com/) in that case.
+
+        If your issue is related to a **custom gym environment**, please use the custom gym env template.
+  - type: textarea
+    id: description
+    attributes:
+      label: 🐛 Bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: To Reproduce
+      description: |
+        Steps to reproduce the behavior. Please try to provide a minimal example to reproduce the bug. Error messages and stack traces are also helpful.
+        Please use the [markdown code blocks](https://help.github.com/en/articles/creating-and-highlighting-code-blocks) for both code and stack traces.
+      value: |
+        ```python
+        from stable_baselines3 import ...
+
+        ```
+
+  - type: textarea
+    id: traceback
+    attributes:
+      label: Relevant log output / Error message
+      description: Please copy and paste any relevant log output / error message. This will be automatically formatted into code, so no need for backticks.
+      placeholder: "Traceback (most recent call last): File ..."
+      render: shell
+
+  - type: textarea
+    id: system-info
+    attributes:
+      label: System Info
+      description: |
+        Describe the characteristic of your environment:
+         * Describe how the library was installed (pip, docker, source, ...)
+         * GPU models and configuration
+         * Python version
+         * PyTorch version
+         * Gym version
+         * Versions of any other relevant libraries
+
+        You can use `sb3.get_system_info()` to print relevant packages info:
+        ```python
+        import stable_baselines3 as sb3
+        sb3.get_system_info()
+        ```
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Checklist
+      options:
+        - label: I have checked that there is no similar [issue](https://github.com/DLR-RM/stable-baselines3/issues) in the repo
+          required: true
+        - label: I have read the [documentation](https://stable-baselines3.readthedocs.io/en/master/)
+          required: true
+        - label: I have provided a minimal working example to reproduce the bug
+          required: true
+        - label: I've used the [markdown code blocks](https://help.github.com/en/articles/creating-and-highlighting-code-blocks) for both code and stack traces.
+          required: true

.github/ISSUE_TEMPLATE/custom_env.yml

@@ -0,0 +1,108 @@
+name: "\U0001F916 Custom Gym Environment Issue"
+description: How to report an issue when using a custom Gym environment
+labels: ["question", "custom gym env"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email.
+        Please post your question on the [RL Discord](https://discord.com/invite/xhfNqQv), [Reddit](https://www.reddit.com/r/reinforcementlearning/) or [Stack Overflow](https://stackoverflow.com/) in that case.
+
+        **Please check your environment first using**:
+        ```python
+        from stable_baselines3.common.env_checker import check_env
+
+        env = CustomEnv(arg1, ...)
+        # It will check your custom environment and output additional warnings if needed
+        check_env(env)
+        ```
+  - type: textarea
+    id: description
+    attributes:
+      label: 🐛 Bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    id: code-example
+    attributes:
+      label: Code example
+      description: |
+        Please try to provide a minimal example to reproduce the bug.
+        For a custom environment, you need to give at least the observation space, action space, `reset()` and `step()` methods (see working example below).
+        Error messages and stack traces are also helpful.
+        Please use the [markdown code blocks](https://help.github.com/en/articles/creating-and-highlighting-code-blocks) for both code and stack traces.
+      value: |
+        ```python
+        import gymnasium as gym
+        import numpy as np
+
+        from stable_baselines3 import A2C
+        from stable_baselines3.common.env_checker import check_env
+
+
+        class CustomEnv(gym.Env):
+
+          def __init__(self):
+            super().__init__()
+            self.observation_space = gym.spaces.Box(low=-np.inf, high=np.inf, shape=(14,))
+            self.action_space = gym.spaces.Box(low=-1, high=1, shape=(6,))
+
+          def reset(self):
+            return self.observation_space.sample(), {}
+
+          def step(self, action):
+            obs = self.observation_space.sample()
+            reward = 1.0
+            done = False
+            truncated = False
+            info = {}
+            return obs, reward, done, truncated, info
+
+        env = CustomEnv()
+        check_env(env)
+
+        model = A2C("MlpPolicy", env, verbose=1).learn(1000)
+        ```
+
+  - type: textarea
+    id: traceback
+    attributes:
+      label: Relevant log output / Error message
+      description: Please copy and paste any relevant log output / error message. This will be automatically formatted into code, so no need for backticks.
+      placeholder: "Traceback (most recent call last): File ..."
+      render: shell
+
+  - type: textarea
+    id: system-info
+    attributes:
+      label: System Info
+      description: |
+        Describe the characteristic of your environment:
+         * Describe how the library was installed (pip, docker, source, ...)
+         * GPU models and configuration
+         * Python version
+         * PyTorch version
+         * Gym version
+         * Versions of any other relevant libraries
+
+        You can use `sb3.get_system_info()` to print relevant packages info:
+        ```python
+        import stable_baselines3 as sb3
+        sb3.get_system_info()
+        ```
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Checklist
+      options:
+        - label: I have checked that there is no similar [issue](https://github.com/DLR-RM/stable-baselines3/issues) in the repo
+          required: true
+        - label: I have read the [documentation](https://stable-baselines3.readthedocs.io/en/master/)
+          required: true
+        - label: I have provided a minimal working example to reproduce the bug
+          required: true
+        - label: I have checked my env using the env checker
+          required: true
+        - label: I've used the [markdown code blocks](https://help.github.com/en/articles/creating-and-highlighting-code-blocks) for both code and stack traces.
+          required: true

.github/ISSUE_TEMPLATE/documentation.yml

@@ -0,0 +1,25 @@
+name: "\U0001F4DA Documentation"
+description: Report an issue related to Stable-Baselines3 documentation
+labels: ["documentation"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email.
+        Please post your question on the [RL Discord](https://discord.com/invite/xhfNqQv), [Reddit](https://www.reddit.com/r/reinforcementlearning/) or [Stack Overflow](https://stackoverflow.com/) in that case.
+  - type: textarea
+    id: description
+    attributes:
+      label: 📚 Documentation
+      description: A clear and concise description of what should be improved in the documentation.
+    validations:
+      required: true
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Checklist
+      options:
+        - label: I have checked that there is no similar [issue](https://github.com/DLR-RM/stable-baselines3/issues) in the repo
+          required: true
+        - label: I have read the [documentation](https://stable-baselines3.readthedocs.io/en/master/)
+          required: true