Skip to content

Commit f009086

Browse files
authored
admin: Set up new issue templates (#1981)
It had escaped my notice that last month, GitHub ended support for a single ISSUE_TEMPLATE.md, and now only supports an ISSUE_TEMPLATE directory with individual templates. I can't imagine the engineering reason for not being able to continue to support having just one template as always. Anyway, so this PR conforms to what they support, by copying (and lightly modifying) the issue templates that OIIO has used for some time. Signed-off-by: Larry Gritz <[email protected]>
1 parent e8b32a2 commit f009086

File tree

6 files changed

+126
-43
lines changed

6 files changed

+126
-43
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 40 deletions
This file was deleted.
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Bug report
3+
about: I think I have identified a legit bug and can describe it.
4+
title: "[BUG]"
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
Note: The prompts below are just to help you formulate a good and actionable
11+
request. Feel free to deviate from this format or to delete this text and
12+
write free-form if you prefer.
13+
14+
**Describe the bug**
15+
16+
A clear and concise description of what the bug is. What happened, and
17+
what did you expect to happen instead.
18+
19+
20+
**OSL version and dependencies**
21+
22+
* OSL branch/version:
23+
* OS:
24+
* C++ compiler:
25+
* LLVM version:
26+
* OIIO version:
27+
28+
29+
**To Reproduce**
30+
31+
Steps to reproduce the behavior:
32+
1. Do this...
33+
2. Then this...
34+
3. Then THIS happens (reproduce the exact error message if you can)
35+
4. Whereas I expected this other specific thing to happen instead.
36+
37+
38+
**Evidence**
39+
40+
- Error messages (paste them here exactly)
41+
- Example shader code (if applicable)
42+
43+
44+
**IF YOU ALREADY HAVE A CODE FIX:** There is no need to file a separate issue,
45+
please just go straight to making a [pull request](https://github.com/AcademySoftwareFoundation/OpenShadingLanguage/pulls).
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Build problems
3+
about: I'm having trouble building OSL. Help!
4+
title: "[BUILD]"
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**PLEASE DO NOT REPORT BUILD TROUBLES AS GITHUB "ISSUES" UNLESS YOU ARE RALLY SURE IT'S A BUG**
11+
12+
The best way to get help with your build problems is to ask a question on the
13+
[osl-dev developer mail list](https://lists.aswf.io/g/osl-dev). For quick
14+
questions, you could also try the [ASWF Slack](https://slack.aswf.io)
15+
`#openshadinglanguage` channel.
16+
17+
When you email about this, please attach one or both of the following:
18+
1. The full verbose build log, which you can create like this:
19+
```make clean ; make VERBOSE=1 > build.log```
20+
2. The `CMakeCache.txt` file from your build directory.
21+
22+
If you are pretty sure that you have identified a **BUG** or other actual
23+
problem with the OSL build scripts and you can describe how to reproduce it,
24+
please file a [bug report issue](https://github.com/AcademySoftwareFoundation/OpenShadingLanguage/issues/new?template=bug_report.md).
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Feature request
3+
about: I have a concrete idea about how to improve OSL.
4+
title: "[FEATURE REQUEST]"
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
Note: The prompts below are just to help you formulate a good and actionable
11+
request. Feel free to deviate from this format or to delete this text and
12+
write free-form if you prefer.
13+
14+
**Is your feature request related to a problem? Please describe.**
15+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
16+
17+
**Describe the solution you'd like**
18+
19+
A clear and concise description of what you want to happen.
20+
21+
**Describe alternatives you've considered**
22+
A clear and concise description of any alternative solutions or features you've considered.
23+
24+
**Additional context**
25+
Add any other context about the feature request here.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Question
3+
about: How do I... I need help with...
4+
title: "[HELP]"
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**PLEASE DO NOT ASK USAGE QUESTIONS USING GITHUB "ISSUES"**
11+
12+
If you are pretty sure that you have identified a **BUG** in OSL, please file
13+
a [bug report issue](https://github.com/AcademySoftwareFoundation/OpenShadingLanguage/issues/new?template=bug_report.md).
14+
15+
But if you are just asking a question:
16+
* How do I...?
17+
* I need help with...
18+
* Am I doing something wrong?
19+
* I can't build OSL
20+
21+
For anything of this nature, the best way to get help using OSL is to ask a
22+
question on the [osl-dev developer mail list](https://lists.aswf.io/g/osl-dev).
23+
For quick questions, you could also try the [ASWF Slack](https://slack.aswf.io) `#openshadinglanguage` channel.
24+
25+
Please check the [documentation](https://docs.openshadinglanguage.org) first;
26+
you may find the answer more quickly than you can get your question answered
27+
on the mail list.
28+

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -495,10 +495,11 @@ Contact & reporting problems
495495
----------------------------
496496

497497
Simple "how do I...", "I'm having trouble", or "is this a bug" questions are
498-
best asked on the [osl-dev developer mail
499-
list](https://lists.aswf.io/g/osl-dev).
498+
best asked on the [osl-dev developer mail list](https://lists.aswf.io/g/osl-dev).
500499
That's where the most people will see it and potentially be able to answer
501-
your question quickly (more so than a GH "issue").
500+
your question quickly (more so than a GH "issue"). For quick questions, you
501+
could also try the [ASWF Slack](https://slack.aswf.io) `#openshadinglanguage`
502+
channel.
502503

503504
Bugs, build problems, and discovered vulnerabilities that you are relatively
504505
certain is a legit problem in the code, and for which you can give clear

0 commit comments

Comments
 (0)