|
1 | | -<!-- This is just a guideline and set of reminders about what constitutes --> |
2 | | -<!-- a good PR. Feel free to delete all this matter and replace it with --> |
3 | | -<!-- your own detailed message about the PR, assuming you hit all the --> |
4 | | -<!-- important points made below. --> |
5 | 1 |
|
6 | 2 |
|
7 | | -## Description |
| 3 | + |
| 4 | +------ :scissors: ------------------------------------------------------------------- |
| 5 | + |
| 6 | +YOU MAY DELETE ALL OF THIS IF YOU ALREADY HAVE A DESCRIPTIVE COMMIT MESSAGE! |
| 7 | + |
| 8 | +This is just a template and set of reminders about what constitutes a good PR. |
| 9 | +But please look over the checklist at the bottom. |
| 10 | + |
| 11 | +If THIS TEXT is still in your PR description, we'll know you didn't read the |
| 12 | +instructions! |
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | + |
| 17 | +### Description |
8 | 18 |
|
9 | 19 | <!-- Please provide a description of what this PR is meant to fix, and --> |
10 | 20 | <!-- how it works (if it's not going to be very clear from the code). --> |
11 | 21 |
|
12 | | -## Tests |
| 22 | +### Tests |
13 | 23 |
|
14 | 24 | <!-- Did you / should you add a testsuite case (new test, or add to an --> |
15 | 25 | <!-- existing test) to verify that this works? --> |
16 | 26 |
|
17 | 27 |
|
18 | | -## Checklist: |
| 28 | +### Checklist: |
19 | 29 |
|
20 | 30 | <!-- Put an 'x' in the boxes as you complete the checklist items --> |
21 | 31 |
|
22 | | -- [ ] I have read the [contribution guidelines](https://github.com/AcademySoftwareFoundation/OpenImageIO/blob/main/CONTRIBUTING.md). |
23 | | -- [ ] I have updated the documentation, if applicable. (Check if there is no |
24 | | - need to update the documentation, for example if this is a bug fix that |
25 | | - doesn't change the API.) |
26 | | -- [ ] I have ensured that the change is tested somewhere in the testsuite |
27 | | - (adding new test cases if necessary). |
28 | | -- [ ] If I added or modified a C++ API call, I have also amended the |
29 | | - corresponding Python bindings (and if altering ImageBufAlgo functions, also |
30 | | - exposed the new functionality as oiiotool options). |
31 | | -- [ ] My code follows the prevailing code style of this project. If I haven't |
32 | | - already run clang-format before submitting, I definitely will look at the CI |
33 | | - test that runs clang-format and fix anything that it highlights as being |
34 | | - nonconforming. |
| 32 | +- [ ] **I have read the guidelines** on [contributions](https://github.com/AcademySoftwareFoundation/OpenImageIO/blob/main/CONTRIBUTING.md) and [code review procedures](https://github.com/AcademySoftwareFoundation/OpenImageIO/blob/main/docs/dev/CodeReview.md). |
| 33 | +- [ ] **I have updated the documentation** if my PR adds features or changes |
| 34 | + behavior. |
| 35 | +- [ ] **I am sure that this PR's changes are tested somewhere in the |
| 36 | + testsuite**. |
| 37 | +- [ ] **I have run and passed the testsuite in CI** *before* submitting the |
| 38 | + PR, by pushing the changes to my fork and seeing that the automated CI |
| 39 | + passed there. (Exceptions: If most tests pass and you can't figure out why |
| 40 | + the remaining ones fail, it's ok to submit the PR and ask for help. Or if |
| 41 | + any failures seem entirely unrelated to your change; sometimes things break |
| 42 | + on the GitHub runners.) |
| 43 | +- [ ] **My code follows the prevailing code style of this project** and I |
| 44 | + fixed any problems reported by the clang-format CI test. |
| 45 | +- [ ] If I added or modified a public C++ API call, I have also amended the |
| 46 | + corresponding Python bindings. If altering ImageBufAlgo functions, I also |
| 47 | + exposed the new functionality as oiiotool options. |
0 commit comments