diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..afd48972 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,48 @@ +name: Bug report +description: Report an issue in kaml +labels: + - is:bug +body: + - type: textarea + attributes: + label: Describe the bug + description: Describe the problem in a few sentences. Please include exact error messages (if any). + validations: + required: true + - type: textarea + attributes: + label: Reproduction repo + description: While not required, if you can provide a simple sample project that demonstrates the problem, this makes it much easier to understand and investigate the issue and validate that it has been fixed. + validations: + required: false + - type: textarea + attributes: + label: Steps to reproduce + description: A clear set of steps that triggers the issue. + validations: + required: true + - type: textarea + attributes: + label: Expected behaviour + description: A description of what you expected to happen. + validations: + required: true + - type: textarea + attributes: + label: Actual behaviour + description: A description of what actually happened. Include any error messages and other surrounding output. + validations: + required: true + - type: textarea + attributes: + label: Version information + description: What version of kaml are you using? (Now is also a good time to double-check you're using the [most recent version](https://github.com/charleskorn/kaml/releases/latest) of kaml.) + render: plain text + validations: + required: true + - type: textarea + attributes: + label: Any other information + description: Is there anything else we need to know? + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..4bf05426 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +blank_issues_enabled: false + +contact_links: + - name: Questions + about: Have a question about kaml? Discussions is the best place for that. + url: https://github.com/charleskorn/kaml/discussions diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..ccb8e60e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,29 @@ +name: Feature request +description: Suggest an idea for kaml +labels: + - is:suggestion +body: + - type: textarea + attributes: + label: Describe the problem you'd like to solve + description: A clear and concise description of what the problem is. For example, [...] is really time consuming and error prone. + validations: + required: true + - type: textarea + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + - type: textarea + attributes: + label: Additional context + description: Add any other context about the feature request here. + validations: + required: false