docs: Add issue templates for bug reports and feature requests #1589
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| name: 🐛 Bug report | ||
| description: Report a problem or unexpected behavior | ||
| labels: [bug] | ||
| body: | ||
| - type: dropdown | ||
| id: component | ||
| attributes: | ||
| label: Component | ||
| description: Which tool or component are you having problems with? | ||
| options: | ||
| - c2pa-rs | ||
| - c2patool | ||
| - c2pa-c | ||
| - Other | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: component-other | ||
| attributes: | ||
| label: If Other, please specify | ||
| description: Which component are you using? | ||
| placeholder: e.g., Python bindings, Java SDK, etc. | ||
|
Contributor
There was a problem hiding this comment. Could we use placeholders that match what we have? Eg. C bindings, docs? |
||
| - type: input | ||
| id: version | ||
| attributes: | ||
| label: Version | ||
| description: Which version are you using? | ||
| placeholder: e.g., v0.71.0 | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: platform | ||
| attributes: | ||
| label: Platform | ||
| description: Which platform are you using? | ||
| options: | ||
| - Linux | ||
| - macOS | ||
| - Windows | ||
| - iOS | ||
| - Android | ||
| - Other | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: what-happened | ||
ribhavh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| attributes: | ||
| label: What happened? | ||
| description: Describe what went wrong. Please attach example files if possible. | ||
| placeholder: Describe the actual behavior you observed. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected-behavior | ||
| attributes: | ||
| label: What did you expect to happen? | ||
| description: Describe what you expected to happen instead. | ||
| placeholder: Describe the expected behavior. | ||
| validations: | ||
| required: true | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| blank_issues_enabled: false | ||
|
Contributor
There was a problem hiding this comment. Hm, I think it's still useful to have blank issues or at least a way to report general tasks/improvements that aren't necessarily features. Not a blocker but just something to think about. For example: |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| name: 💡 Feature request | ||
| description: Suggest an idea for improvement | ||
| labels: [enhancement] | ||
| body: | ||
| - type: textarea | ||
| id: idea | ||
| attributes: | ||
| label: Describe your idea | ||
| description: What would make the project better? | ||
| placeholder: Describe your feature request here. | ||
|
Contributor
There was a problem hiding this comment. Do we need to add a question about what is the target platform? |
||
| validations: | ||
| required: true | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| name: 💬 Other | ||
| description: General inquiries, questions, or discussions | ||
| labels: [question] | ||
| body: | ||
| - type: textarea | ||
| id: details | ||
| attributes: | ||
| label: Details | ||
| description: Tell us what's on your mind. | ||
| placeholder: Describe your inquiry, question, or feedback here. | ||
| validations: | ||
| required: true |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.