Skip to content

Commit 607dbda

Browse files
BordawilliamFalcon
authored andcommitted
update GitHub templates (#612)
1 parent 5d00e62 commit 607dbda

File tree

4 files changed

+65
-34
lines changed

4 files changed

+65
-34
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+35-15
Original file line numberDiff line numberDiff line change
@@ -11,32 +11,52 @@ assignees: ''
1111
1. Tensorboard not showing in Jupyter-notebook see [issue 79](https://github.com/williamFalcon/pytorch-lightning/issues/79).
1212
2. PyTorch 1.1.0 vs 1.2.0 support [see FAQ](https://github.com/williamFalcon/pytorch-lightning#faq)
1313

14-
### Describe the bug
15-
A clear and concise description of what the bug is.
14+
## 🐛 Bug
15+
16+
<!-- A clear and concise description of what the bug is. -->
17+
18+
### To Reproduce
1619

17-
#### To Reproduce
1820
Steps to reproduce the behavior:
21+
1922
1. Go to '...'
2023
2. Run '....'
2124
3. Scroll down to '....'
2225
4. See error
2326

27+
<!-- If you have a code sample, error messages, stack traces, please provide it here as well -->
28+
29+
2430
#### Code sample
25-
Ideally attach a minimal code sample to reproduce the decried issue.
26-
[Minimal means having the shortest code but still preserving the bug]
31+
<!-- Ideally attach a minimal code sample to reproduce the decried issue.
32+
Minimal means having the shortest code but still preserving the bug. -->
33+
34+
### Expected behavior
2735

28-
#### Expected behavior
29-
A clear and concise description of what you expected to happen.
36+
<!-- A clear and concise description of what you expected to happen. -->
3037

31-
#### Screenshots
32-
If applicable, add screenshots to help explain your problem.
38+
### Environment
3339

34-
### Environment information
40+
Please copy and paste the output from our
41+
[environment collection script](https://raw.githubusercontent.com/pytorch/pytorch/master/torch/utils/collect_env.py)
42+
(or fill out the checklist below manually).
3543

36-
Desktop (please complete the following information):
37-
- OS: [e.g. iOS, Linux, Win]
38-
- Packaging [e.g. pip, conda]
39-
- Version [e.g. 0.5.2.1]
44+
You can get the script and run it with:
45+
```
46+
wget https://raw.githubusercontent.com/pytorch/pytorch/master/torch/utils/collect_env.py
47+
# For security purposes, please check the contents of collect_env.py before running it.
48+
python collect_env.py
49+
```
50+
51+
- PyTorch Version (e.g., 1.0):
52+
- OS (e.g., Linux):
53+
- How you installed PyTorch (`conda`, `pip`, source):
54+
- Build command you used (if compiling from source):
55+
- Python version:
56+
- CUDA/cuDNN version:
57+
- GPU models and configuration:
58+
- Any other relevant information:
4059

4160
### Additional context
42-
Add any other context about the problem here.
61+
62+
<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/typos-and-doc-fixes.md .github/ISSUE_TEMPLATE/documentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ assignees: ''
77

88
---
99

10-
## Typos and docs fixes
10+
## 📚 Documentation
1111

1212
For typos and doc fixes, please go ahead and:
1313

.github/ISSUE_TEMPLATE/feature_request.md

+15-8
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,21 @@ assignees: ''
77

88
---
99

10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
10+
## 🚀 Feature
11+
<!-- A clear and concise description of the feature proposal -->
1212

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
13+
### Motivation
1514

16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
15+
<!-- Please outline the motivation for the proposal. Is your feature request related to a problem? e.g., I'm always frustrated when [...]. If this is related to another GitHub issue, please link here too -->
1816

19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
17+
### Pitch
18+
19+
<!-- A clear and concise description of what you want to happen. -->
20+
21+
### Alternatives
22+
23+
<!-- A clear and concise description of any alternative solutions or features you've considered, if any. -->
24+
25+
### Additional context
26+
27+
<!-- Add any other context or screenshots about the feature request here. -->

.github/ISSUE_TEMPLATE/how-to-question.md

+14-10
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,24 @@ assignees: ''
77

88
---
99

10+
## ❓ Questions and Help
11+
1012
### Before asking:
1113
1. search the issues.
1214
2. search the docs.
1315

14-
If you still can't find what you need:
15-
#### What is your question?
16+
<!-- If you still can't find what you need: -->
17+
18+
#### What is your question?
19+
20+
#### Code
21+
22+
<!-- Please paste a code snippet if your question requires it! -->
1623

17-
#### Code
18-
Please paste a code snippet if your question requires it!
24+
#### What have you tried?
1925

20-
#### What have you tried?
26+
#### What's your environment?
2127

22-
#### What's your environment?
23-
- conda version (no venv)
24-
- PyTorch version
25-
- Lightning version
26-
- Test-tube version
28+
- OS: [e.g. iOS, Linux, Win]
29+
- Packaging [e.g. pip, conda]
30+
- Version [e.g. 0.5.2.1]

0 commit comments

Comments
 (0)