diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..2ffb7714 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,34 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright (c) 2025 Robin Jarry +--- +name: Bug Report +description: File a bug report. +labels: ["bug", "triage"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + Make sure to check if a similar bug wasn't already reported and/or + fixed by searching through existing issues and pull requests (including + closed ones). + - type: textarea + id: description + attributes: + label: Description + description: | + Please describe what is the issue with as much detail as possible. + Include any relevant logs, error messages and/or core dump backtraces. + Also include what are the steps to reproduce the problem. + placeholder: Bug description... + validations: + required: true + - type: input + id: version + attributes: + label: Version + description: What version of grout is the bug observed on? + placeholder: grout --version + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..f2010582 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright (c) 2025 Robin Jarry +--- +blank_issues_enabled: false +contact_links: + - name: Mailing List + url: mailto:grout@dpdk.org + about: Please ask and answer questions here (subscription not required). + - name: Mailing List Archives + url: https://mails.dpdk.org/archives/grout/ + about: Browse through previous discussions. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..837aa004 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,34 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright (c) 2025 Robin Jarry +--- +name: Feature Request +description: Request for a new feature. +labels: ["feature", "triage"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to request a new feature! + + Make sure to check if a similar feature wasn't already requested and/or + implemented by searching through existing issues and pull requests + (including closed ones). + - type: textarea + id: description + attributes: + label: Description + description: | + Please describe what feature is missing. You can include as much detail + as you want, including code snippets and external links. + placeholder: Feature description... + validations: + required: true + - type: textarea + id: context + attributes: + label: Context and Use Cases + description: | + Explain why you need this feature and how it will be used. + placeholder: Context and use-cases... + validations: + required: true diff --git a/README.md b/README.md index 86a1c9ed..8a30130d 100644 --- a/README.md +++ b/README.md @@ -280,6 +280,11 @@ Use ? for help and for command completion. grout# ``` +## Contact + +* Mailing list: grout@dpdk.org ([archives](http://mails.dpdk.org/archives/grout/)) +* Slack channel: [#grout @ dpdkproject.slack.com](https://dpdkproject.slack.com/archives/C07NAFWE1MG) + ## Contributing Anyone can contribute to `grout`. See [`CONTRIBUTING.md`](/CONTRIBUTING.md).