mirror of
https://github.com/saymrwulf/stable-baselines3.git
synced 2026-11-17 08:56:08 +00:00
Add templates
This commit is contained in:
parent
b66003cfb3
commit
d514cd9126
2 changed files with 81 additions and 0 deletions
52
.github/ISSUE_TEMPLATE/issue-template.md
vendored
Normal file
52
.github/ISSUE_TEMPLATE/issue-template.md
vendored
Normal file
|
|
@ -0,0 +1,52 @@
|
||||||
|
---
|
||||||
|
name: Issue Template
|
||||||
|
about: How to create an issue for this repository
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Important Note: We do not do technical support, nor consulting** and don't answer personal questions per email.
|
||||||
|
|
||||||
|
If you have any questions, feel free to create an issue with the tag [question].
|
||||||
|
If you wish to suggest an enhancement or feature request, add the tag [feature request].
|
||||||
|
If you are submitting a bug report, please fill in the following details.
|
||||||
|
|
||||||
|
If your issue is related to a custom gym environment, please check it first using:
|
||||||
|
|
||||||
|
```python
|
||||||
|
from torchy_baselines.common.env_checker import check_env
|
||||||
|
|
||||||
|
env = CustomEnv(arg1, ...)
|
||||||
|
# It will check your custom environment and output additional warnings if needed
|
||||||
|
check_env(env)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Describe the bug**
|
||||||
|
A clear and concise description of what the bug is.
|
||||||
|
|
||||||
|
**Code example**
|
||||||
|
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.
|
||||||
|
|
||||||
|
```python
|
||||||
|
from torchy_baselines import ...
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
Traceback (most recent call last): File ...
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
**System Info**
|
||||||
|
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
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
Add any other context about the problem here.
|
||||||
29
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
29
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,29 @@
|
||||||
|
<!--- Provide a general summary of your changes in the Title above -->
|
||||||
|
|
||||||
|
## Description
|
||||||
|
<!--- Describe your changes in detail -->
|
||||||
|
|
||||||
|
## Motivation and Context
|
||||||
|
<!--- Why is this change required? What problem does it solve? -->
|
||||||
|
<!--- If it fixes an open issue, please link to the issue here. -->
|
||||||
|
<!--- You can use the syntax `closes #100` if this solves the issue #100 -->
|
||||||
|
- [ ] I have raised an issue to propose this change ([required](https://github.com/hill-a/stable-baselines/blob/master/CONTRIBUTING.md) for new features and bug fixes)
|
||||||
|
|
||||||
|
## Types of changes
|
||||||
|
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
|
||||||
|
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||||
|
- [ ] New feature (non-breaking change which adds functionality)
|
||||||
|
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
|
||||||
|
- [ ] Documentation (update in the documentation)
|
||||||
|
|
||||||
|
## Checklist:
|
||||||
|
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
|
||||||
|
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
|
||||||
|
- [ ] I've read the [CONTRIBUTION](https://github.com/hill-a/stable-baselines/blob/master/CONTRIBUTING.md) guide (**required**)
|
||||||
|
- [ ] I have updated the changelog accordingly (**required**).
|
||||||
|
- [ ] My change requires a change to the documentation.
|
||||||
|
- [ ] I have updated the tests accordingly (*required for a bug fix or a new feature*).
|
||||||
|
- [ ] I have updated the documentation accordingly.
|
||||||
|
- [ ] I have ensured `pytest` and `pytype` both pass.
|
||||||
|
|
||||||
|
<!--- This Template is an edited version of the one from https://github.com/evilsocket/pwnagotchi/ -->
|
||||||
Loading…
Reference in a new issue