diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..b705e510 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,69 @@ +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema +name: "\U0001F41E Bug report" +description: Create a bug report +labels: + - "bug" + - "triage" + +body: + - type: markdown + attributes: + value: | + **Thank :heart: you for taking the time to fill out this bug report!** + + We kindly ask that you search to see if an issue [already exists](https://github.com/kernelkit/infix/issues?q=is%3Aissue+sort%3Acreated-desc+) for the bug you encountered. + + - type: textarea + attributes: + label: Current Behavior + description: | + A clear and concise description of the issue you're experiencing. + value: | + For code snippets, logs, commands, etc., please use triple backticks: + ``` + admin@infix-c0-ff-ee:/> show log + May 15 07:21:02 infix-00-00-00 container[3192]: Failed creating container test from curios-httpd-v24.03.0 + - (press h for help or q to quit) + ``` + validations: + required: true + + - type: textarea + attributes: + label: Expected Behavior + description: | + A clear and concise description of what you expected to happen. + value: | + ``` + admin@infix-c0-ff-ee:/> show log + May 15 07:21:02 infix-c0-ff-ee container[3192]: Successfully created container test from curios-httpd-v24.03.0 + - (press h for help or q to quit) + ``` + validations: + required: true + + - type: textarea + attributes: + label: Steps To Reproduce + description: | + Steps to reproduce the issue. For example: + + 1. Built from source + 2. Upgrade to latest release, vYY.MM.P + 3. Factory reset + 4. Enable feature + 5. Check the logs/show command/operational status + validations: + required: false + + - type: textarea + attributes: + label: Additional information + description: | + - Relevant parts of `startup-config` + - Output from `show interfaces`, if applicable + - Other observations, screenshots, log files ... + + **Tip:** You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..029f2e35 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,7 @@ +contact_links: + - name: "🔍 Look for my Issue" + url: https://github.com/kernelkit/infix/issues?q=is%3Aissue+sort%3Acreated-desc+ + about: Thank ❤️ you for your time! We kindly ask that you first check if an issue already exists. + - name: "💬 Discussions and Q&A" + url: https://github.com/kernelkit/infix/discussions + about: Discussions are perfect for quick questions, bouncing ideas, and things that may be a bug. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..32e83898 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,45 @@ +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema +name: "\U0001F6E0️ Feature request" +description: Suggest a new feature, idea or improvement of the OS +labels: + - "feature" + - "triage" + +body: + - type: markdown + attributes: + value: | + **Thank :heart: you for taking the time to fill out this feature request!** + + We kindly ask that you search to see if an issue [already exists](https://github.com/kernelkit/infix/issues?q=is%3Aissue+sort%3Acreated-desc+) for your feature. We are also happy to accept contributions from our users. For details see [CONTRIBUTING](https://github.com/kernelkit/infix/blob/master/.github/CONTRIBUTING.md). + + - type: textarea + attributes: + label: Description + description: | + A clear and concise description of the problem or missing feature. + **Example:** *I'm always frustrated when [...]*, or *I'd like to see support for [...]* + validations: + required: true + + - type: textarea + attributes: + label: Additional Information + description: | + Any other related information, e.g. existing YANG model(s), or possibly screenshots about the feature request here. + validations: + required: false + + - type: textarea + attributes: + label: General Information + description: | + Appended to all feature requests for future readers. + value: | + Anyone can help out by [sponsoring][1] development of new features or [contributing][2] pull requests. + Please use this issue for discussions related to the feature. + + [1]: https://github.com/kernelkit/infix/blob/main/.github/SUPPORT.md + [2]: https://github.com/kernelkit/infix/blob/main/.github/CONTRIBUTING.md + validations: + required: true