diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 8b91ff3a09..92f292d7bb 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -10,16 +10,21 @@ assignees: '' -## Please reproduce using the BoringModel - - - - ### To Reproduce -Use following [**BoringModel**](https://colab.research.google.com/drive/1HvWVVTK8j2Nj52qU4Q4YCyzOm0_aLQF3?usp=sharing) and 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). + + - PyTorch Lightning Version (e.g., 1.3.0): - PyTorch Version (e.g., 1.8) - Python version: diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index e78df92a18..363a0a54bd 100644 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -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! diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 01c5d00b58..c73cda501e 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,6 +8,7 @@ assignees: '' --- ## 🚀 Feature + ### Motivation @@ -26,10 +27,18 @@ assignees: '' +--- -#### 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. + + +- [**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. + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 03178a88f4..5603dd70ce 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,8 +2,8 @@ Fixes # -### Does your PR introduce any breaking changes ? If yes, please list them. +### Does your PR introduce any breaking changes? If yes, please list them. - + ## 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? - - +- [ ] 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) + ## 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 🙃