From ed97231e09282138cbe545ec43a244424ad7f15e Mon Sep 17 00:00:00 2001 From: Jirka Borovec Date: Sat, 7 Dec 2019 06:23:01 +0100 Subject: [PATCH] update GitHub templates (#601) --- .github/ISSUE_TEMPLATE/bug_report.md | 26 ++++++++++++------- .github/ISSUE_TEMPLATE/typos-and-doc-fixes.md | 3 ++- 2 files changed, 18 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 05efc5b2..d98076fb 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -11,26 +11,32 @@ assignees: '' 1. Tensorboard not showing in Jupyter-notebook see [issue 79](https://github.com/williamFalcon/pytorch-lightning/issues/79). 2. PyTorch 1.1.0 vs 1.2.0 support [see FAQ](https://github.com/williamFalcon/pytorch-lightning#faq) -**Describe the bug** +### Describe the bug A clear and concise description of what the bug is. -**To Reproduce** +#### To Reproduce Steps to reproduce the behavior: 1. Go to '...' -2. Click on '....' +2. Run '....' 3. Scroll down to '....' 4. See error -**Expected behavior** +#### Code sample +Ideally attach a minimal code sample to reproduce the decried issue. +[Minimal means having the shortest code but still preserving the bug] + +#### Expected behavior A clear and concise description of what you expected to happen. -**Screenshots** +#### Screenshots If applicable, add screenshots to help explain your problem. -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +### Environment information -**Additional context** +Desktop (please complete the following information): + - OS: [e.g. iOS, Linux, Win] + - Packaging [e.g. pip, conda] + - Version [e.g. 0.5.2.1] + +### Additional context Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/typos-and-doc-fixes.md b/.github/ISSUE_TEMPLATE/typos-and-doc-fixes.md index 1e9e9017..b9b61ef4 100644 --- a/.github/ISSUE_TEMPLATE/typos-and-doc-fixes.md +++ b/.github/ISSUE_TEMPLATE/typos-and-doc-fixes.md @@ -7,11 +7,12 @@ assignees: '' --- +## Typos and docs fixes + For typos and doc fixes, please go ahead and: 1. Create an issue. 2. Fix the typo. 3. Submit a PR. - Thanks!