|
| 1 | +<!-- |
| 2 | + For Work In Progress Pull Requests, please use the Draft PR feature, |
| 3 | + see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further details. |
| 4 | +
|
| 5 | + For a timely review/response, please avoid force-pushing additional |
| 6 | + commits if your PR already received reviews or comments. |
| 7 | +
|
| 8 | + Before submitting a Pull Request, please ensure you've done the following: |
| 9 | + - 📖 Read the our Code of Conduct: https://github.com/python-thread/thread/blob/main/CODE_OF_CONDUCT.md |
| 10 | + - 👷♀️ Create small PRs. In most cases this will be possible. |
| 11 | + - ✅ Provide tests for your changes. |
| 12 | + - 📝 Use descriptive commit messages. |
| 13 | + - 📗 Update any related documentation and include any relevant screenshots. |
| 14 | +--> |
| 15 | + |
| 16 | +## What type of PR is this? (check all applicable) |
| 17 | + |
| 18 | +- [ ] Refactor |
| 19 | +- [ ] Feature |
| 20 | +- [ ] Bug Fix |
| 21 | +- [ ] Optimization |
| 22 | +- [ ] Breaking Change |
| 23 | +- [ ] Documentation Update |
| 24 | + |
| 25 | + |
| 26 | + |
| 27 | +## Description |
| 28 | + |
| 29 | + |
| 30 | + |
| 31 | + |
| 32 | +## Related Tickets & Documents |
| 33 | + |
| 34 | +<!-- |
| 35 | +For pull requests that relate or close an issue, please include them |
| 36 | +below. We like to follow [Github's guidance on linking issues to pull requests](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). |
| 37 | +
|
| 38 | +For example having the text: "closes #1234" would connect the current pull |
| 39 | +request to issue 1234. And when we merge the pull request, Github will |
| 40 | +automatically close the issue. |
| 41 | +--> |
| 42 | + |
| 43 | +- Related Issue # |
| 44 | +- Closes # |
| 45 | + |
| 46 | + |
| 47 | + |
| 48 | +## QA Instructions, Screenshots, Recordings |
| 49 | + |
| 50 | +_Please replace this line with instructions on how to test your changes, a note |
| 51 | +on the devices and browsers this has been tested on, as well as any relevant |
| 52 | +images for UI changes._ |
| 53 | + |
| 54 | + |
| 55 | + |
| 56 | +## Added/updated tests? |
| 57 | +_We encourage you to keep the code coverage percentage at 80% and above._ |
| 58 | + |
| 59 | +- [ ] Yes |
| 60 | +- [ ] No, and this is why: _please replace this line with details on why tests |
| 61 | + have not been included_ |
| 62 | +- [ ] I need help with writing tests |
| 63 | + |
| 64 | + |
| 65 | + |
| 66 | +## [optional] Are there any post deployment tasks we need to perform? |
| 67 | + |
| 68 | + |
| 69 | + |
| 70 | + |
| 71 | +## Checklist |
| 72 | +<!--- |
| 73 | +Go over all the following points, and put an `x` in all the boxes that apply. |
| 74 | +If you're unsure about any of these, don't hesitate to ask. We're here to help! |
| 75 | +--> |
| 76 | +- [ ] My code follows the code style of this project. |
| 77 | +- [ ] My change requires a change to the documentation. |
| 78 | +- [ ] I have updated the documentation accordingly. |
0 commit comments