Rooba
/
lightning
mirror of https://github.com/Lightning-AI/lightning.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update issue and PR templates (#8528) 

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
This commit is contained in:
Carlos Mocholí 2021-07-26 12:30:07 +02:00 committed by GitHub
parent 52526c20b5
commit 428dc2e1b0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 46 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -10,16 +10,21 @@ assignees: ''
<!-- A clear and concise description of what the bug is. -->
## Please reproduce using the BoringModel
<!-- Please paste your BoringModel colab link here. -->
### To Reproduce
Use following [**BoringModel**](https://colab.research.google.com/drive/1HvWVVTK8j2Nj52qU4Q4YCyzOm0_aLQF3?usp=sharing) and post here
<!--
Please reproduce using the BoringModel!
<!-- If you could not reproduce using the BoringModel and still think there's a bug, please post here -->
You can use the following Colab link:
https://colab.research.google.com/drive/1HvWVVTK8j2Nj52qU4Q4YCyzOm0_aLQF3?usp=sharing
IMPORTANT: has to be public.
or this simple template:
https://github.com/PyTorchLightning/pytorch-lightning/blob/master/pl_examples/bug_report_model.py
If you could not reproduce using the BoringModel and still think there's a bug, please post here
but remember, bugs with code are fixed faster!
-->
### Expected behavior
@ -27,20 +32,20 @@ Use following [**BoringModel**](https://colab.research.google.com/drive/1HvWVVTK
### Environment
**Note**: `Bugs with code` are solved faster ! `Colab Notebook` should be made `public` !
* `IDE`: Please, use our python [bug_report_model.py](https://github.com/PyTorchLightning/pytorch-lightning/blob/master/pl_examples/bug_report_model.py
) template.
* `Colab Notebook`: Please copy and paste the output from our [environment collection script](https://raw.githubusercontent.com/PyTorchLightning/pytorch-lightning/master/requirements/collect_env_details.py) (or fill out the checklist below manually).
<!--
Please copy and paste the output from our environment collection script:
https://raw.githubusercontent.com/PyTorchLightning/pytorch-lightning/master/requirements/collect_env_details.py
(For security purposes, please check the contents of the script before running it)
You can get the script and run it with:
```
```bash
wget https://raw.githubusercontent.com/PyTorchLightning/pytorch-lightning/master/requirements/collect_env_details.py
# For security purposes, please check the contents of collect_env_details.py before running it.
python collect_env_details.py
```
You can also fill out the list below manually.
-->
- PyTorch Lightning Version (e.g., 1.3.0):
- PyTorch Version (e.g., 1.8)
- Python version:

2
.github/ISSUE_TEMPLATE/documentation.md vendored
View File

@ -15,4 +15,6 @@ For typos and doc fixes, please go ahead and:
2. Fix the typo.
3. Submit a PR.
For very simple fixes, you can submit a PR without a linked issue.
Thanks!

19
.github/ISSUE_TEMPLATE/feature_request.md vendored
View File

@ -8,6 +8,7 @@ assignees: ''
---
## 🚀 Feature
<!-- A clear and concise description of the feature proposal -->
### Motivation
@ -26,10 +27,18 @@ assignees: ''
<!-- Add any other context or screenshots about the feature request here. -->
---
#### If you enjoy PL, check out our other projects:
#### If you enjoy Lightning, check out our other projects! ⚡
- [Metrics](https://github.com/PyTorchLightning/metrics): Machine learning metrics for distributed, scalable PyTorch applications.
- [Flash](https://github.com/PyTorchLightning/lightning-flash): The fastest way to get a Lightning baseline! A collection of tasks for fast prototyping, baselining, finetuning and solving problems with deep learning
- [Bolts](https://github.com/PyTorchLightning/lightning-bolts): Pretrained SOTA Deep Learning models, callbacks and more for research and production with PyTorch Lightning and PyTorch
- [Lightning Transformers](https://github.com/PyTorchLightning/lightning-transformers): Flexible interface for high performance research using SOTA Transformers leveraging Pytorch Lightning, Transformers, and Hydra.
<sub>
- [**Metrics**](https://github.com/PyTorchLightning/metrics): Machine learning metrics for distributed, scalable PyTorch applications.
- [**Flash**](https://github.com/PyTorchLightning/lightning-flash): The fastest way to get a Lightning baseline! A collection of tasks for fast prototyping, baselining, finetuning and solving problems with deep learning
- [**Bolts**](https://github.com/PyTorchLightning/lightning-bolts): Pretrained SOTA Deep Learning models, callbacks and more for research and production with PyTorch Lightning and PyTorch
- [**Lightning Transformers**](https://github.com/PyTorchLightning/lightning-transformers): Flexible interface for high performance research using SOTA Transformers leveraging Pytorch Lightning, Transformers, and Hydra.
</sub>

18
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -2,8 +2,8 @@
<!--
Please include a summary of the change and which issue is fixed.
Please also include relevant motivation and context.
List any dependencies that are required for this change.
Please also include relevant motivation and context.
List any dependencies that are required for this change.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.
@ -11,24 +11,25 @@ The following links the related issue to the PR (https://docs.github.com/en/free
-->
Fixes #<issue_number>
### Does your PR introduce any breaking changes ? If yes, please list them.
### Does your PR introduce any breaking changes? If yes, please list them.
<!-- In the CHANGELOG, separate each item in the unreleased section by a blank line to reduce collisions -->
<!-- FILL IN or None -->
## Before submitting
- [ ] Was this **discussed/approved** via a GitHub issue? (not for typos and docs)
- [ ] Did you read the [contributor guideline](https://github.com/PyTorchLightning/pytorch-lightning/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? (if necessary)
- [ ] Did you write any **new necessary tests**? (not for typos and docs)
- [ ] Did you verify new and **existing tests pass** locally with your changes?
- [ ] Did you **update the [CHANGELOG](https://github.com/PyTorchLightning/pytorch-lightning/blob/master/CHANGELOG.md)**? (not for typos, docs, test updates, or internal minor changes/refactorings)
- [ ] Did you list all the **breaking changes** introduced by this pull request?
<!-- For CHANGELOG separate each item in the unreleased section by a blank line to reduce collisions -->
- [ ] Did you **update the [CHANGELOG](https://github.com/PyTorchLightning/pytorch-lightning/blob/master/CHANGELOG.md)**? (not for typos, docs, test updates, or internal minor changes/refactorings)
<!-- In the CHANGELOG, separate each item in the unreleased section by a blank line to reduce collisions -->
## PR review
Anyone in the community is free to review the PR once the tests have passed.
Anyone in the community is welcome to review the PR.
Before you start reviewing make sure you have read [Review guidelines](https://github.com/PyTorchLightning/pytorch-lightning/wiki/Review-guidelines). In short, see the following bullet-list:
- [ ] Is this pull request ready for review? (if not, please submit in draft mode)
@ -37,4 +38,5 @@ Before you start reviewing make sure you have read [Review guidelines](https://g
- [ ] Add labels and milestones (and optionally projects) to the PR so it can be classified
## Did you have fun?
Make sure you had fun coding 🙃