Skip to content

Commit deb68be

Browse files
authored
admin: Minor rewording in the issue and PR templates (#4982)
Periodic revisiting of the phrasing in the hopes of improving PR and Issue quality / actionability. Not that I think they are bad now, just always looking to guide people to improvements. Will it work? 🤷 Let's try and see if we think PRs improve. If not, we can revise again later. Also make the issue title prefixes less yelly and shorter (makes it easier to see the actual title on phone or other limited width display of messages). Signed-off-by: Larry Gritz <[email protected]>
1 parent 0fe78f7 commit deb68be

File tree

5 files changed

+42
-27
lines changed

5 files changed

+42
-27
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
---
22
name: Bug report
33
about: I think I have identified a legit bug and can describe it.
4-
title: "[BUG]"
4+
title: "bug:"
55
labels: ''
66
assignees: ''
77

88
---
99

10+
<!-- THESE ARE JUST SUGGESTIONS. FEEL FREE TO DELETE ALL OF THIS AND -->
11+
<!-- WRITE YOUR OWN THOROUGH BUG REPORT. -->
12+
1013
**Describe the bug**
1114

1215
A clear and concise description of what the bug is. What happened, and

.github/ISSUE_TEMPLATE/build_problem.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Build problems
33
about: I'm having trouble building OIIO. Help!
4-
title: "[BUILD]"
4+
title: "build:"
55
labels: ''
66
assignees: ''
77

@@ -10,7 +10,8 @@ assignees: ''
1010
**PLEASE DO NOT REPORT BUILD TROUBLES AS GITHUB "ISSUES" UNLESS YOU ARE REALLY SURE IT'S A BUG**
1111

1212
The best way to get help with your build problems is to ask a question on the
13-
[oiio-dev developer mail list](https://lists.aswf.io/g/oiio-dev).
13+
[oiio-dev developer mail list](https://lists.aswf.io/g/oiio-dev) or on the
14+
[ASWF Slack](https://slack.aswf.io) `#openimageio` channel.
1415

1516
When you email about this, please attach one or both of the following:
1617
1. The full verbose build log, which you can create like this:

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
---
22
name: Feature request
33
about: I have a concrete idea about how to improve OpenImageIO.
4-
title: "[FEATURE REQUEST]"
4+
title: "feat:"
55
labels: ''
66
assignees: ''
77

88
---
99

10+
<!-- THESE ARE JUST SUGGESTIONS. FEEL FREE TO DELETE ALL OF THIS AND -->
11+
<!-- WRITE YOUR OWN THOROUGH FEATURE REQUEST. -->
12+
1013
**Is your feature request related to a problem? Please describe.**
1114
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1215

.github/ISSUE_TEMPLATE/question.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Question
33
about: How do I... I need help with...
4-
title: "[HELP]"
4+
title: "help:"
55
labels: ''
66
assignees: ''
77

@@ -18,8 +18,8 @@ But if you are just asking a question:
1818
* Am I doing something wrong?
1919
* I can't build OpenImageIO
2020

21-
For anything of this nature, the best way to get help using OpenImageIO is
22-
to ask a question on the [oiio-dev developer mail list](https://lists.aswf.io/g/oiio-dev).
21+
For anything of this nature, the best way to get help using OpenImageIO is to
22+
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.
2323

2424
The [documentation](https://docs.openimageio.org)
2525
is pretty comprehensive, so please check there first; you may find the answer

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,42 @@
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. -->
1+
YOU MAY DELETE ALL OF THIS IF YOU ALREADY HAVE A DESCRIPTIVE COMMIT MESSAGE!
52

3+
This is just a template and set of reminders about what constitutes a good PR.
4+
But please look over the checklist at the bottom.
65

7-
## Description
6+
If THIS TEXT is still in your PR description, we'll know you didn't read the
7+
instructions!
8+
9+
10+
11+
12+
### Description
813

914
<!-- Please provide a description of what this PR is meant to fix, and -->
1015
<!-- how it works (if it's not going to be very clear from the code). -->
1116

12-
## Tests
17+
### Tests
1318

1419
<!-- Did you / should you add a testsuite case (new test, or add to an -->
1520
<!-- existing test) to verify that this works? -->
1621

1722

18-
## Checklist:
23+
### Checklist:
1924

2025
<!-- Put an 'x' in the boxes as you complete the checklist items -->
2126

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.
27+
- [ ] **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).
28+
- [ ] **I have updated the documentation** if my PR adds features or changes
29+
behavior.
30+
- [ ] **I am sure that this PR's changes are tested somewhere in the
31+
testsuite**.
32+
- [ ] **I have run and passed the testsuite in CI** *before* submitting the
33+
PR, by pushing the changes to my fork and seeing that the automated CI
34+
passed there. (Exceptions: If most tests pass and you can't figure out why
35+
the remaining ones fail, it's ok to submit the PR and ask for help. Or if
36+
any failures seem entirely unrelated to your change; sometimes things break
37+
on the GitHub runners.)
38+
- [ ] **My code follows the prevailing code style of this project** and I
39+
fixed any problems reported by the clang-format CI test.
40+
- [ ] If I added or modified a public C++ API call, I have also amended the
41+
corresponding Python bindings. If altering ImageBufAlgo functions, I also
42+
exposed the new functionality as oiiotool options.

0 commit comments

Comments
 (0)