diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..da85f5d --- /dev/null +++ b/.github/CODEOWNERS @@ -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 diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..9a8ee0d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..ed0678d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..4e2dc4f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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. \ No newline at end of file diff --git a/.github/workflows/json-validate.yml b/.github/workflows/json-validate.yml index 696b413..40b82da 100644 --- a/.github/workflows/json-validate.yml +++ b/.github/workflows/json-validate.yml @@ -1,8 +1,7 @@ name: json-yaml-validate on: push: - branches: - - master + branches: ['master', 'main'] pull_request: workflow_dispatch: