I am suggesting to add a pull request template to standardize and keep PRs of high quality to this repo :) š š
Screenshots
[upload the screenshot here]
Not needed.
Context Links
Add links & resources such as documentation of libraries, etc.
Not needed,
Checklist before requesting a review
[x] I have performed a self-review of my code
[ ] If it is a core feature, I have added thorough tests.
[x] Extended the README / documentation, if necessary
[ ] Do we need to implement analytics?
[ ] My changes generate no new warnings
[ ] Is the code readable? Prefer to see more self-explanatory and consistency
[ ] Is the code tested properly? i.e. where appropriate, we're testing well-explained failures, behaviours, fixes, etc
Caveats/Notes
Talk about things reviewers should be aware about
(Please include here if you created a new environment variables and ensure you have communicated this secret to the team)
Prompts
Where would you like the reviewer to focus their energy on?
Any particular areas of code that you'd like to reduce complexity, technical debt, risk, or needs further optimization?
Open to suggestions to the overall format of the PR š
Please let me know if there are any other suggestions to make to this template. We can use this PR to add, remove, edit what is here if necessary.
We may need a Chinese šØš³ version PR template for the repo possibly but I am not fluent but we can simply add a Chinese version to the .github folder.
Pull Request Type
Dictionary of Definitions here
Description
I am suggesting to add a pull request template to standardize and keep PRs of high quality to this repo :) š š
Screenshots
[upload the screenshot here]
Not needed.
Context Links
Not needed,
Checklist before requesting a review
Caveats/Notes
Talk about things reviewers should be aware about (Please include here if you created a new environment variables and ensure you have communicated this secret to the team)
Prompts
Open to suggestions to the overall format of the PR š
Please let me know if there are any other suggestions to make to this template. We can use this PR to add, remove, edit what is here if necessary.
We may need a Chinese šØš³ version PR template for the repo possibly but I am not fluent but we can simply add a Chinese version to the .github folder.