Skip to content

Commit 94c622d

Browse files
authored
Create a new issue template (#1350)
* Create a new issue template Fixes #1348 Signed-off-by: Jon Skeet <jonskeet@google.com> * Wrap text Signed-off-by: Jon Skeet <skeet@pobox.com> --------- Signed-off-by: Jon Skeet <jonskeet@google.com> Signed-off-by: Jon Skeet <skeet@pobox.com>
1 parent 3fd0012 commit 94c622d

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

.github/ISSUE_TEMPLATE/issue.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: New issue
3+
about: 'Create a new issue'
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
(Please remove the text below after reading it.)
10+
11+
When filing an issue in this repository, please consider the following:
12+
13+
- Is this:
14+
- A feature request for a new form of integration etc?
15+
- A report of a technical issue with the existing spec?
16+
- A suggestion for improving the clarity of the existing spec
17+
(even if it's not "wrong" as such)?
18+
- Something else?
19+
- Is there context behind your request that would be useful for readers to
20+
understand? (There's no need to go into huge amounts of detail, but a few
21+
sentences about the motivation can be really helpful.)
22+
- Do you know *roughly* what you'd expect a change to address this issue would
23+
look like? If so, it's useful to create a PR at the same time, linking to
24+
the issue. This doesn't need to be polished and ready to merge - it's just to
25+
help clarify roughly what you're considering.
26+
27+
If the issue is requires discussion, it's really useful if you're able to
28+
attend the weekly working group meeting as described
29+
[here](https://github.com/cloudevents/spec/?tab=readme-ov-file#meeting-time).
30+
Often a discussion which would take multiple back-and-forth comments on an
31+
issue can be resolved with a few minutes of conversation. We understand the
32+
timing may not be convenient for everyone - please let us know if that's the
33+
case, and we can potentially arrange something with the most relevant group
34+
members at a more convenient time.

0 commit comments

Comments
 (0)