Update PR template
This commit is contained in:
parent
79fcf54e1e
commit
95892f31e6
|
|
@ -1,13 +1,11 @@
|
||||||
<!--- Provide a general summary of your changes in the Title above -->
|
<!--- Provide a general summary of your changes in the Title above (e.g. feature name, fix of a bug)-->
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
<!--- Describe your changes in detail -->
|
<!--- Describe your changes in detail, including links to any sources for new features -->
|
||||||
|
|
||||||
## Motivation and Context
|
## Context
|
||||||
<!--- Why is this change required? What problem does it solve? -->
|
<!--- Link the related issue here. You can use the syntax `closes #100` if this solves the issue #100 -->
|
||||||
<!--- If it fixes an open issue, please link to the issue here. -->
|
- [ ] I have raised an issue to propose this change ([required](https://github.com/Stable-Baselines-Team/stable-baselines3-contrib/blob/master/CONTRIBUTING.md))
|
||||||
<!--- 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/DLR-RM/stable-baselines3/blob/master/CONTRIBUTING.md) for new features and bug fixes)
|
|
||||||
|
|
||||||
## Types of changes
|
## Types of changes
|
||||||
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
|
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
|
||||||
|
|
@ -19,11 +17,13 @@
|
||||||
## Checklist:
|
## Checklist:
|
||||||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
|
<!--- 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! -->
|
<!--- 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/DLR-RM/stable-baselines3/blob/master/CONTRIBUTING.md) guide (**required**)
|
- [ ] I've read the [CONTRIBUTION](https://github.com/Stable-Baselines-Team/stable-baselines3-contrib/blob/master/CONTRIBUTING.md) guide (**required**)
|
||||||
- [ ] I have updated the changelog accordingly (**required**).
|
- [ ] The functionality/performance matches that of the source (**required** for new training algorithms or training-related features).
|
||||||
- [ ] 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 tests accordingly (*required for a bug fix or a new feature*).
|
||||||
|
- [ ] I have included an example of using the feature (*required for new features*).
|
||||||
|
- [ ] I have included baseline results (**required** for new training algorithms or training-related features).
|
||||||
- [ ] I have updated the documentation accordingly.
|
- [ ] I have updated the documentation accordingly.
|
||||||
|
- [ ] I have updated the changelog accordingly (**required**).
|
||||||
- [ ] I have reformatted the code using `make format` (**required**)
|
- [ ] I have reformatted the code using `make format` (**required**)
|
||||||
- [ ] I have checked the codestyle using `make check-codestyle` and `make lint` (**required**)
|
- [ ] I have checked the codestyle using `make check-codestyle` and `make lint` (**required**)
|
||||||
- [ ] I have ensured `make pytest` and `make type` both pass. (**required**)
|
- [ ] I have ensured `make pytest` and `make type` both pass. (**required**)
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue