From f96d238d968db8b4e9e8bf669f47f6170655a1f8 Mon Sep 17 00:00:00 2001 From: Sebastian Schuberth Date: Sat, 27 Apr 2024 19:06:43 +0200 Subject: [PATCH] feat(github): Create issue templates Resolves #6540. Signed-off-by: Sebastian Schuberth --- .github/ISSUE_TEMPLATE/bug.md | 53 +++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 7 ++++ .github/ISSUE_TEMPLATE/enhancement.md | 22 +++++++++++ .github/ISSUE_TEMPLATE/feature.md | 22 +++++++++++ 4 files changed, 104 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/enhancement.md create mode 100644 .github/ISSUE_TEMPLATE/feature.md diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000000000..2adedcc7428d5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,53 @@ +--- +name: Bug Report +about: I want to report a bug that I am facing. +title: '' +labels: 'bug' + +--- +**Describe the bug** + +A clear and concise description of what the bug is. + +**To Reproduce** + +Steps to reproduce the behavior: +1. First do '...' +2. Then do '...' +3. Finally do '...' +4. See error + +**Expected behavior** + +A clear and concise description of what you expected to happen. + +**Console / log output** + +Add console and / or log output that shows the error and additional context. No screenshots of plain text please, to keep text searchable. + +``` + +``` + +**Environment** + +Output of the `ort requirements` command: + +``` + +``` + +*Or* manually specify: +- ORT version: [e.g. 22.1.0] +- Java version: [e.g. 17] +- OS: [e.g. Linux] + +*And* specify (relevant parts of) your ORT configuration (`config.yml`): + +``` + +``` + +**Additional context** + +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000000..d2ee7b30a7087 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,7 @@ +contact_links: +- name: Discuss an Idea + about: Start a discussion or ask a longer question. + url: https://github.com/oss-review-toolkit/ort/discussions +- name: Ask a Question + about: Ask a quick question or just chat with the ORT community. + url: http://slack.oss-review-toolkit.org/ diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md new file mode 100644 index 0000000000000..ddf696702789e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -0,0 +1,22 @@ +--- +name: Enhancement Proposal +about: I want to propose to enhance existing functionality. +title: '' +labels: 'enhancement' + +--- +**What is the existing functionality and how should it be enhanced?** + +A clear and concise description of what you propose to change and why it is an enhancement. + +**What is the use-case for your enhancement?** + +A clear and concise description of which users would benefit from the enhancement. + +**Alternatives you have considered** + +A clear and concise description of any alternative solutions you have considered. + +**Additional context** + +Add any other context or screenshots about the enhancement proposal here. diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md new file mode 100644 index 0000000000000..c170a3c8072b8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -0,0 +1,22 @@ +--- +name: Feature Request +about: I want to request a new feature that I find useful. +title: '' +labels: 'new feature' + +--- +**What is the feature you want to request?** + +A clear and concise description of what problem the feature addresses. + +**Describe the solution you would like** + +A clear and concise description of what you want to happen. + +**Alternatives you have considered** + +A clear and concise description of any alternative solutions you have considered. + +**Additional context** + +Add any other context or screenshots about the feature request here.