add issue + PR template for other contributors
Pull Request Type
Dictionary of Definitions here
- [x] Just a heads up 🙆
- [ ] Sanity check 🏃♂️
- [ ] Work in progress (WIP) 🏗️
- [ ] Early feedback ✍️
- [ ] Line-by-line review 📝
- [ ] Pull request to a pull request 🔀
Description
I am suggesting to add a simplified issue and simplified pull request template to standardize created issues and PRs for standardization purposes :) 😄 🚀
I believe this will help ensure issues and PRs are written in a coherent format so that other community members can help action and contribute to them!
Once this is merge up to main, any new Issues or PRs will automatically pull in the template as found in the .github folder which is a special reserved key word folder name for github repos.
Screenshots
N/A [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?
- [x] 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)
I also added a .gitignore as that was missing from the repo so to enhance git safety I added widely standardized python project .gitigore 😄
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. This is an evolving document for the community. 🙌🏽