update GH templates (#97)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Lightning-AI · Feb 3, 2023 · d8f0b17 · d8f0b17
1 parent a4fbe03
commit d8f0b17
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 24 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -12,25 +12,26 @@ assignees: ''
 
 ### To Reproduce
 
-Steps to reproduce the behavior:
-
-1. Go to '...'
-1. Run '....'
-1. Scroll down to '....'
-1. See error
+Steps to reproduce the behavior...
 
 <!-- If you have a code sample, error messages, stack traces, please provide it here as well -->
 
-#### Code sample
+<details>
+  <summary><b>Code sample</b></summary>
 
 <!-- Ideally attach a minimal code sample to reproduce the decried issue.
 Minimal means having the shortest code but still preserving the bug. -->
 
+</details>
+
 ### Expected behavior
 
 <!-- A clear and concise description of what you expected to happen. -->
 
-### Environment
+### Additional context
+
+<details>
+  <summary><b>Environment details</b></summary>
 
 - PyTorch Version (e.g., 1.0):
 - OS (e.g., Linux):
@@ -41,6 +42,6 @@ Minimal means having the shortest code but still preserving the bug. -->
 - GPU models and configuration:
 - Any other relevant information:
 
-### Additional context
+</details>
 
 <!-- Add any other context about the problem here. -->
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
@@ -8,10 +8,7 @@ assignees: ''
 
 ## 📚 Documentation
 
-For typos and doc fixes, please go ahead and:
-
-1. Create an issue.
-1. Fix the typo.
-1. Submit a PR.
+For typos or docs fixes, please go ahead and submit a PR (no need to open an issue).
+If you are not sure about the proper solution, please describe the issue here...
 
 Thanks!
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -14,10 +14,6 @@ assignees: ''
 
 <!-- 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 -->
 
-### Pitch
-
-<!-- A clear and concise description of what you want to happen. -->
-
 ### Alternatives
 
 <!-- A clear and concise description of any alternative solutions or features you've considered, if any. -->

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,9 +1,12 @@
-# Before submitting
+<details>
+  <summary><b>Before submitting</b></summary>
 
-- [ ] Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
+- [ ] Was this discussed/agreed via a Github issue? (no need for typos and docs improvements)
 - [ ] Did you read the [contributor guideline](https://github.com/Lightning-AI/lightning/blob/master/.github/CONTRIBUTING.md), Pull Request section?
-- [ ] Did you make sure to update the docs?
-- [ ] Did you write any new necessary tests?
+- Did you make sure to update the docs?
+- [ ] Did all existing and newly added tests pas locally?
+
+</details>
 
 ## What does this PR do?
 
@@ -12,8 +15,10 @@ Fixes # (issue).
 ## PR review
 
 Anyone in the community is free to review the PR once the tests have passed.
-If we didn't discuss your PR in Github issues there's a high chance it will not be merged.
+If we didn't discuss your PR in GitHub issues there's a high chance it will not be merged.
 
-## Did you have fun?
+<!--
+Did you have fun?
 
 Make sure you had fun coding 🙃
+-->