diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 487b6e8bdc2..150f7849963 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -16,11 +16,14 @@ Steps to reproduce the behavior... -#### Code sample +
+ Code sample +
+ ### Expected behavior diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index c74b3408000..456d49be454 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/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0c6881d0228..318ee5483eb 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,18 +2,24 @@ Fixes #\ -## Before submitting +
+ Before submitting -- [ ] 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/metrics/blob/master/.github/CONTRIBUTING.md), Pull Request section? - [ ] Did you make sure to **update the docs**? - [ ] Did you write any new **necessary tests**? -## PR review +
+ +
+ 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. +
+ ## Did you have fun? Make sure you had fun coding 🙃