diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 61fb0396..86f435d3 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,16 +1,40 @@ - +# Description -## Pre-flight checklist +Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. -- [ ] I have read the [Contributing Guidelines](https://snigdhaos.org/documentation/#-helping). +Fixes # (issue) -## Context +## Type of change -## Description +What type of changes you have made? +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update -## Related issues/PRs +# How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration + +- [ ] Physical Machine +- [ ] Virtual Machine + +**Test Configuration**: +* Snigdha OS Build: +* Snigdha OS Version: +* CPU: +* RAM: +* SDK: + +# Checklist: + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] Any dependent changes have been merged and published in downstream modules -