From 834feadd1f9241250b9769d7dc42e2dc4cd508c1 Mon Sep 17 00:00:00 2001 From: Jirka B Date: Mon, 16 Sep 2024 13:32:52 +0200 Subject: [PATCH] templates --- .github/ISSUE_TEMPLATE/bug_report.md | 23 +++++++++-------- .github/ISSUE_TEMPLATE/config.yml | 8 ++++++ .github/ISSUE_TEMPLATE/documentation.md | 5 ++-- .github/ISSUE_TEMPLATE/how-to-question.md | 30 ----------------------- .github/PULL_REQUEST_TEMPLATE.md | 23 +++++++++-------- 5 files changed, 36 insertions(+), 53 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/how-to-question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index a78343c328..70192ee44d 100644 --- 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... -#### Code sample +
+ Code sample + +```python +# Ideally attach a minimal code sample to reproduce the decried issue. +# Minimal means having the shortest code but still preserving the bug. +``` - +
### Expected behavior -### Environment +
+ Environment - PyTorch Version (e.g., 1.0): - OS (e.g., Linux): @@ -41,6 +42,8 @@ Minimal means having the shortest code but still preserving the bug. --> - GPU models and configuration: - Any other relevant information: +
+ ### Additional context diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..b8b40fe44e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Ask a Question + url: https://github.com/Lightning-Universe/lightning-bolts/discussions/new + about: Ask and answer TorchMetrics related questions + - name: 💬 Chat with us + url: https://discord.gg/VptPCZkGNa + about: Live chat with experts, engineers, and users in our Discord community. diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index c74b340800..456d49be45 100644 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -10,8 +10,7 @@ assignees: '' For typos and doc fixes, please go ahead and: -1. Create an issue. -1. Fix the typo. -1. Submit a PR. +- For a simple typo or fix, please send directly a PR (no need to create an issue) +- If you are not sure about the proper solution, please describe here your finding... Thanks! diff --git a/.github/ISSUE_TEMPLATE/how-to-question.md b/.github/ISSUE_TEMPLATE/how-to-question.md deleted file mode 100644 index bf9a228178..0000000000 --- a/.github/ISSUE_TEMPLATE/how-to-question.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: How to question -about: Asking how-to questions -title: '' -labels: question -assignees: '' ---- - -## ❓ Questions and Help - -### Before asking: - -1. search the issues. -1. search the docs. - - - -#### What is your question? - -#### Code - - - -#### What have you tried? - -#### What's your environment? - -- OS: \[e.g. iOS, Linux, Win\] -- Packaging \[e.g. pip, conda\] -- Version \[e.g. 0.5.2.1\] diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 54def0787c..f5b7ff2e8a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,3 +1,16 @@ +
+ Before submitting + +- [ ] Was this **discussed/approved** via a Github issue? (no need for typos and docs improvements) +- [ ] Did you read the [contributor guideline](https://github.com/PyTorchLightning/lightning-bolts/blob/master/.github/CONTRIBUTING.md), Pull Request section? +- [ ] Did you make sure your PR does **only one thing**, instead of bundling different changes together? +- [ ] Did you make sure to **update the documentation** with your changes? +- [ ] Did you write any **new necessary tests**? \[not needed for typos/docs\] +- [ ] Did you verify new and **existing tests** pass locally with your changes? +- [ ] If you made a notable change (that affects users), did you update the [CHANGELOG](https://github.com/PyTorchLightning/lightning-bolts/blob/master/CHANGELOG.md)? + +
+ ## What does this PR do? ## PR review