diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c1810d405f..3307c930f7 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,12 +1,15 @@ --- name: Bug report about: I think I have identified a legit bug and can describe it. -title: "[BUG]" +title: "bug:" labels: '' assignees: '' --- + + + **Describe the bug** A clear and concise description of what the bug is. What happened, and diff --git a/.github/ISSUE_TEMPLATE/build_problem.md b/.github/ISSUE_TEMPLATE/build_problem.md index 8de9b6aa0d..179a1fb242 100644 --- a/.github/ISSUE_TEMPLATE/build_problem.md +++ b/.github/ISSUE_TEMPLATE/build_problem.md @@ -1,7 +1,7 @@ --- name: Build problems about: I'm having trouble building OIIO. Help! -title: "[BUILD]" +title: "build:" labels: '' assignees: '' @@ -10,7 +10,8 @@ assignees: '' **PLEASE DO NOT REPORT BUILD TROUBLES AS GITHUB "ISSUES" UNLESS YOU ARE REALLY SURE IT'S A BUG** The best way to get help with your build problems is to ask a question on the -[oiio-dev developer mail list](https://lists.aswf.io/g/oiio-dev). +[oiio-dev developer mail list](https://lists.aswf.io/g/oiio-dev) or on the +[ASWF Slack](https://slack.aswf.io) `#openimageio` channel. When you email about this, please attach one or both of the following: 1. The full verbose build log, which you can create like this: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 9ec5c4a787..a563507875 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,12 +1,15 @@ --- name: Feature request about: I have a concrete idea about how to improve OpenImageIO. -title: "[FEATURE REQUEST]" +title: "feat:" labels: '' assignees: '' --- + + + **Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 51a27aac18..7f389cbac2 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -1,7 +1,7 @@ --- name: Question about: How do I... I need help with... -title: "[HELP]" +title: "help:" labels: '' assignees: '' @@ -18,8 +18,8 @@ But if you are just asking a question: * Am I doing something wrong? * I can't build OpenImageIO -For anything of this nature, the best way to get help using OpenImageIO is -to ask a question on the [oiio-dev developer mail list](https://lists.aswf.io/g/oiio-dev). +For anything of this nature, the best way to get help using OpenImageIO is to +ask a question on the [oiio-dev developer mail list](https://lists.aswf.io/g/oiio-dev) or the [ASWF Slack](https://slack.aswf.io) `#openimageio` channel. The [documentation](https://docs.openimageio.org) is pretty comprehensive, so please check there first; you may find the answer diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 960bc557b3..536ef4915c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,34 +1,42 @@ - - - - +YOU MAY DELETE ALL OF THIS IF YOU ALREADY HAVE A DESCRIPTIVE COMMIT MESSAGE! +This is just a template and set of reminders about what constitutes a good PR. +But please look over the checklist at the bottom. -## Description +If THIS TEXT is still in your PR description, we'll know you didn't read the +instructions! + + + + +### Description -## Tests +### Tests -## Checklist: +### Checklist: -- [ ] I have read the [contribution guidelines](https://github.com/AcademySoftwareFoundation/OpenImageIO/blob/main/CONTRIBUTING.md). -- [ ] I have updated the documentation, if applicable. (Check if there is no - need to update the documentation, for example if this is a bug fix that - doesn't change the API.) -- [ ] I have ensured that the change is tested somewhere in the testsuite - (adding new test cases if necessary). -- [ ] If I added or modified a C++ API call, I have also amended the - corresponding Python bindings (and if altering ImageBufAlgo functions, also - exposed the new functionality as oiiotool options). -- [ ] My code follows the prevailing code style of this project. If I haven't - already run clang-format before submitting, I definitely will look at the CI - test that runs clang-format and fix anything that it highlights as being - nonconforming. +- [ ] **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). +- [ ] **I have updated the documentation** if my PR adds features or changes + behavior. +- [ ] **I am sure that this PR's changes are tested somewhere in the + testsuite**. +- [ ] **I have run and passed the testsuite in CI** *before* submitting the + PR, by pushing the changes to my fork and seeing that the automated CI + passed there. (Exceptions: If most tests pass and you can't figure out why + the remaining ones fail, it's ok to submit the PR and ask for help. Or if + any failures seem entirely unrelated to your change; sometimes things break + on the GitHub runners.) +- [ ] **My code follows the prevailing code style of this project** and I + fixed any problems reported by the clang-format CI test. +- [ ] If I added or modified a public C++ API call, I have also amended the + corresponding Python bindings. If altering ImageBufAlgo functions, I also + exposed the new functionality as oiiotool options.