diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3c1d721d5..7a1e213c8 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,40 @@ -Before you submit this PR, please make sure: +### Goal of this PR + -- You have read the contribution guidelines -- You include an example that validates your change -- Your English is grammatically correct +... + +### How is this PR achieving the goal + + +... + +### Natives Documented + + +... + +### Documentation Details + + +... + +### Successfully Tested Examples + + +- [ ] Examples provided have been tested and verified for accuracy. + +### Documentation and Examples + + +- [ ] Detailed descriptions have been provided for each native. +- [ ] Parameters and return values have been thoroughly explained. +- [ ] Usage examples have been included to demonstrate practical applications. + +### Checklist + + +- [ ] The documentation accurately reflects the functionality of the natives. +- [ ] My commit message clearly explains the purpose and content of the documentation. + +### Addresses Research Questions +