diff --git a/.github/ISSUE_TEMPLATES/bug_report.yml b/.github/ISSUE_TEMPLATES/bug_report.yml new file mode 100644 index 0000000..44c6d26 --- /dev/null +++ b/.github/ISSUE_TEMPLATES/bug_report.yml @@ -0,0 +1,75 @@ +name: Bug report +description: Found a bug? Let us know so we can fix it! +labels: ["type: bug"] + +body: + - type: textarea + id: reproduction-steps + attributes: + label: Steps to reproduce + description: Steps to reproduce the bug. This can also be a code snippet. Steps to reproduce the bug. This can also be a code snippet. + value: | + 1. + 2. + 3. + 4. + validations: + required: true + + - type: textarea + id: expected-result + attributes: + label: Expected result + description: What should have happened if the bug wasn't there? + validations: + required: true + + - type: textarea + id: actual-result + attributes: + label: Actual result + description: What happened exactly? If you have a traceback, please provide all of it. + validations: + required: true + + - type: input + id: library-version + attributes: + label: Library version + description: mcproto version used when this bug was encountered. (Find out with `pip show mcproto` command) + placeholder: 0.1.0 + validations: + required: true + + - type: input + id: python-version + attributes: + label: Python version + description: Version of python interpreter you're using. (Find out with `python -V` or `py -V`) + placeholder: 3.11.1 + validations: + required: true + + - type: input + id: operating-system + attributes: + label: Operating system + description: Operating system used when this bug was encountered. + placeholder: Windows 11 / Linux - Ubuntu 22.10 / MacOS / ... + + - type: textarea + id: further-info + attributes: + label: Further info + description: Any further info or images go here. + + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: Make sure to tick all the following boxes. + options: + - label: I have searched the issue tracker and have made sure it's not a duplicate. If it is a follow up of another issue, I have specified it. + required: true + - label: I have made sure to remove ANY sensitive information (passwords, credentials, personal details, etc.). + required: true diff --git a/.github/ISSUE_TEMPLATES/config.yml b/.github/ISSUE_TEMPLATES/config.yml new file mode 100644 index 0000000..0086358 --- /dev/null +++ b/.github/ISSUE_TEMPLATES/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATES/feature_request.yml b/.github/ISSUE_TEMPLATES/feature_request.yml new file mode 100644 index 0000000..d2e10df --- /dev/null +++ b/.github/ISSUE_TEMPLATES/feature_request.yml @@ -0,0 +1,36 @@ +name: Feature request +description: Got a cool idea you would like implemented? Share it with us! +labels: ["type: feature"] + +body: + - type: textarea + id: summary + attributes: + label: Summary + description: Small summary of the feature. + validations: + required: true + + - type: textarea + id: problem + attributes: + label: Why is this needed? + description: Why should this feature be implemented? What problem(s) would it solve? + validations: + required: true + + - type: textarea + id: ideal-implementation + attributes: + label: Ideal implementation + description: How should this feature be implemented? + value: To be decided. + + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: Make sure to tick all the following boxes. + options: + - label: I have searched the issue tracker and have made sure it's not a duplicate. If it is a follow up of another issue, I have specified it. + required: true