From d514cd9126842b4f83f855be0fc8d1f73e540819 Mon Sep 17 00:00:00 2001 From: Antonin Raffin Date: Mon, 27 Jan 2020 14:36:11 +0100 Subject: [PATCH] Add templates --- .github/ISSUE_TEMPLATE/issue-template.md | 52 ++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 29 +++++++++++++ 2 files changed, 81 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/issue-template.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/issue-template.md b/.github/ISSUE_TEMPLATE/issue-template.md new file mode 100644 index 0000000..2e2e61b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue-template.md @@ -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. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..0d40764 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,29 @@ + + +## Description + + +## Motivation and Context + + + +- [ ] 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 + +- [ ] 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: + + +- [ ] 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. + +