From cfcc0a871c1e2a19075b8ef2fdca50e32f49fa96 Mon Sep 17 00:00:00 2001 From: Ashwin Bharambe Date: Wed, 6 Nov 2024 22:49:01 -0800 Subject: [PATCH] Slightly update PR template --- .github/PULL_REQUEST_TEMPLATE.md | 29 ++++++++++++----------------- 1 file changed, 12 insertions(+), 17 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a92442dc1..79701d926 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,17 +1,14 @@ # What does this PR do? -Closes # (issue) +In short, provide a summary of what this PR does and why. Usually, the relevant context should be present in a linked issue. + +- [ ] Addresses issue (#issue) ## Feature/Issue validation/testing/test plan -Please describe the tests that you ran to verify your changes and relevant result summary. Provide instructions so it can be reproduced. -Please also list any relevant details for your test configuration or test plan. - -- [ ] Test A -Logs for Test A - -- [ ] Test B -Logs for Test B +Please describe: + - tests you ran to verify your changes with result summaries. + - provide instructions so it can be reproduced. ## Sources @@ -20,12 +17,10 @@ Please link relevant resources if necessary. ## Before submitting -- [ ] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case). -- [ ] Did you read the [contributor guideline](https://github.com/meta-llama/llama-stack/blob/main/CONTRIBUTING.md), - Pull Request section? -- [ ] Was this discussed/approved via a Github issue? Please add a link - to it if that's the case. -- [ ] Did you make sure to update the documentation with your changes? -- [ ] Did you write any new necessary tests? -Thanks for contributing 🎉! +- [ ] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case). +- [ ] Ran pre-commit to handle lint / formatting issues. +- [ ] Read the [contributor guideline](https://github.com/meta-llama/llama-stack/blob/main/CONTRIBUTING.md), + Pull Request section? +- [ ] Updated relevant documentation. +- [ ] Wrote necessary unit or integration tests.