Skip to content

Commit 834fead

Browse files
committed
templates
1 parent 431020f commit 834fead

File tree

5 files changed

+36
-53
lines changed

5 files changed

+36
-53
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+13-10
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,26 @@ assignees: ''
1212

1313
### To Reproduce
1414

15-
Steps to reproduce the behavior:
16-
17-
1. Go to '...'
18-
1. Run '....'
19-
1. Scroll down to '....'
20-
1. See error
15+
Steps to reproduce the behavior...
2116

2217
<!-- If you have a code sample, error messages, stack traces, please provide it here as well -->
2318

24-
#### Code sample
19+
<details>
20+
<summary>Code sample</summary>
21+
22+
```python
23+
# Ideally attach a minimal code sample to reproduce the decried issue.
24+
# Minimal means having the shortest code but still preserving the bug.
25+
```
2526

26-
<!-- Ideally attach a minimal code sample to reproduce the decried issue.
27-
Minimal means having the shortest code but still preserving the bug. -->
27+
</details>
2828

2929
### Expected behavior
3030

3131
<!-- A clear and concise description of what you expected to happen. -->
3232

33-
### Environment
33+
<details>
34+
<summary>Environment</summary>
3435

3536
- PyTorch Version (e.g., 1.0):
3637
- OS (e.g., Linux):
@@ -41,6 +42,8 @@ Minimal means having the shortest code but still preserving the bug. -->
4142
- GPU models and configuration:
4243
- Any other relevant information:
4344

45+
</details>
46+
4447
### Additional context
4548

4649
<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a Question
4+
url: https://github.com/Lightning-Universe/lightning-bolts/discussions/new
5+
about: Ask and answer TorchMetrics related questions
6+
- name: 💬 Chat with us
7+
url: https://discord.gg/VptPCZkGNa
8+
about: Live chat with experts, engineers, and users in our Discord community.

.github/ISSUE_TEMPLATE/documentation.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ assignees: ''
1010

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

13-
1. Create an issue.
14-
1. Fix the typo.
15-
1. Submit a PR.
13+
- For a simple typo or fix, please send directly a PR (no need to create an issue)
14+
- If you are not sure about the proper solution, please describe here your finding...
1615

1716
Thanks!

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

-30
This file was deleted.

.github/PULL_REQUEST_TEMPLATE.md

+13-10
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
<details>
2+
<summary><b>Before submitting</b></summary>
3+
4+
- [ ] Was this **discussed/approved** via a Github issue? (no need for typos and docs improvements)
5+
- [ ] Did you read the [contributor guideline](https://github.com/PyTorchLightning/lightning-bolts/blob/master/.github/CONTRIBUTING.md), Pull Request section?
6+
- [ ] Did you make sure your PR does **only one thing**, instead of bundling different changes together?
7+
- [ ] Did you make sure to **update the documentation** with your changes?
8+
- [ ] Did you write any **new necessary tests**? \[not needed for typos/docs\]
9+
- [ ] Did you verify new and **existing tests** pass locally with your changes?
10+
- [ ] If you made a notable change (that affects users), did you update the [CHANGELOG](https://github.com/PyTorchLightning/lightning-bolts/blob/master/CHANGELOG.md)?
11+
12+
</details>
13+
114
## What does this PR do?
215

316
<!--
@@ -8,16 +21,6 @@ Please include a summary of the change and which issue is fixed.
821

922
Fixes # (issue)
1023

11-
## Before submitting
12-
13-
- [ ] Was this **discussed/approved** via a Github issue? (no need for typos and docs improvements)
14-
- [ ] Did you read the [contributor guideline](https://github.com/PyTorchLightning/lightning-bolts/blob/master/.github/CONTRIBUTING.md), Pull Request section?
15-
- [ ] Did you make sure your PR does **only one thing**, instead of bundling different changes together?
16-
- [ ] Did you make sure to **update the documentation** with your changes?
17-
- [ ] Did you write any **new necessary tests**? \[not needed for typos/docs\]
18-
- [ ] Did you verify new and **existing tests** pass locally with your changes?
19-
- [ ] If you made a notable change (that affects users), did you update the [CHANGELOG](https://github.com/PyTorchLightning/lightning-bolts/blob/master/CHANGELOG.md)?
20-
2124
<!-- For CHANGELOG separate each item in unreleased section by a blank line to reduce collisions -->
2225

2326
## PR review

0 commit comments

Comments
 (0)