-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement Issue templates; Codeowners; Labeler Action (#26)
* Implement Bug Report and Feature Request Templates * Implement CODEOWNERS and config.yml * Update Feature Request to have actual YAML Format * Remove Document Start Header to fix YAML Parsing * Update to handle master and main branches --------- Co-authored-by: Chats <[email protected]>
- Loading branch information
1 parent
f600242
commit 7b40e44
Showing
5 changed files
with
120 additions
and
2 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains 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,9 @@ | ||
# Defines owners of specific parts of the codebase. | ||
|
||
# Global owner of all code | ||
* @dealloc @chatterchats | ||
|
||
# All documentation should be approved by following owners | ||
*.md @chatterchats | ||
*.tree @chatterchats | ||
*.cfg @chatterchats |
This file contains 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,62 @@ | ||
name: "\U0001F41E Bug report" | ||
description: Report something that isn't working as it should or is outright broken | ||
title: "[BUG]: " | ||
labels: ["bug"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
**Before You Start...** | ||
This form is only for submitting bug reports. If you have a usage question | ||
or are unsure if this is really a bug, make sure to: | ||
- Read the [docs](https://helldivers-2.github.io/json/readme.html) | ||
- Ask on [Discord Chat](https://discord.gg/E8UUfWYmf9) | ||
Also try to search for your issue - it may have already been answered or even fixed in the development branch. | ||
However, if you find that an old, closed issue still persists in the latest version, | ||
you should open a new issue using the form below instead of commenting on the old issue. | ||
- type: input | ||
id: reproduction-path | ||
attributes: | ||
label: Faulty File Path & Name | ||
description: | | ||
Provide the path that is malfunctioning. | ||
Please do not just fill in a random path. The issue will be closed if no valid path or filename is provided. | ||
placeholder: /path/to/file.json | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: request-data | ||
attributes: | ||
label: Request information | ||
description: | | ||
Provide as much information about your issue as you can. JSON Snippets or just brief overview of what is wrong. | ||
placeholder: Request information | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: expected | ||
attributes: | ||
label: What is expected? | ||
description: | | ||
This can range from a textual explanation of what you were expecting to see/happen to providing JSON snippets | ||
that illustrate what should be outputted. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: actually-happening | ||
attributes: | ||
label: What is actually happening? | ||
description: | | ||
Explain what is happening that deviates from the expected output. | ||
render: json | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: additional-comments | ||
attributes: | ||
label: Any additional comments? | ||
description: e.g. some background/context of how you ran into this bug. |
This file contains 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,11 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Discord Chat | ||
url: https://discord.gg/E8UUfWYmf9 | ||
about: Ask questions and discuss with other developers in real time. | ||
- name: Questions & Discussions | ||
url: https://github.com/helldivers-2/json/discussions | ||
about: Use GitHub discussions for message-board style questions and discussions. | ||
- name: Buy me a coffee | ||
url: https://www.buymeacoffee.com/dealloc | ||
about: If you want to support the development, check out buymeacoffee |
This file contains 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,37 @@ | ||
name: Feature request | ||
about: Suggest new features for the API | ||
title: '[FEATURE]: ' | ||
labels: ['feature request'] | ||
body: | ||
- type: textarea | ||
id: problem-solved | ||
attributes: | ||
label: What problem is solved? | ||
description: | | ||
A clear and concise description of what the problem is. | ||
placeholder: I'm always frustrated when [...] | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: problem-solution | ||
attributes: | ||
label: What is the solution? | ||
description: | | ||
A clear and concise description of what you want to happen. | ||
placeholder: This problem is solved by doing [...] | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: value-add | ||
attributes: | ||
label: What value does this add? | ||
description: | | ||
A clear description of the value this feature would add to the community and applications. | ||
placeholder: This would add value to the project by [...] | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: additional-comments | ||
attributes: | ||
label: Any additional comments? | ||
description: Add any other context or screenshots about the feature request here. |
This file contains 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