From 6fd91b55f0c1853f5f1786d8f4c87b0f4c7fcdd4 Mon Sep 17 00:00:00 2001 From: Valentin Knabel Date: Fri, 3 Feb 2023 16:29:23 +0100 Subject: [PATCH] chore(github): issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 11 ++++++----- .github/ISSUE_TEMPLATE/docs.md | 16 ++++++++++++++++ .github/ISSUE_TEMPLATE/library.md | 13 +++++++++++++ .github/ISSUE_TEMPLATE/proposal.md | 15 +++++++++++++++ 4 files changed, 50 insertions(+), 5 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/docs.md create mode 100644 .github/ISSUE_TEMPLATE/library.md create mode 100644 .github/ISSUE_TEMPLATE/proposal.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index a770f4e..08118fb 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,10 +1,9 @@ --- name: Bug report about: Create a report to help us improve -title: '' +title: "" labels: bug -assignees: '' - +assignees: "" --- **Describe the bug** @@ -12,6 +11,7 @@ A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: + 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' @@ -24,8 +24,9 @@ A clear and concise description of what you expected to happen. If applicable, add screenshots to help explain your problem. **Versions:** - - Operating System: - - `lithia --version` + +- Operating System: +- `lithia --version` **Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/docs.md b/.github/ISSUE_TEMPLATE/docs.md new file mode 100644 index 0000000..54cc753 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs.md @@ -0,0 +1,16 @@ +--- +name: Question +about: If the documentation is unclear or wrong, please let us know! +title: "Question: " +labels: docs +assignees: "" +--- + +**Question** +What is your question? Please be as specific as possible. + +**Context** +Where did you find the documentation? What is the URL? + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/library.md b/.github/ISSUE_TEMPLATE/library.md new file mode 100644 index 0000000..7a46881 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/library.md @@ -0,0 +1,13 @@ +--- +name: Submit library +about: You created a library? Link it! +title: "Library: " +labels: docs +assignees: "" +--- + +**Library** +Name and link to your library. + +**Description** +Describe your library in a few words. diff --git a/.github/ISSUE_TEMPLATE/proposal.md b/.github/ISSUE_TEMPLATE/proposal.md new file mode 100644 index 0000000..352b024 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/proposal.md @@ -0,0 +1,15 @@ +--- +name: Proposal or idea +about: Pitch a proposal or an idea +title: "Proposal: " +labels: proposal +--- + +**Introduction** +What is the proposed feature? What problem does it solve? + +**Motivation** +Why is this change important to you? How would you use it? How can it benefit other users? + +**Proposed Solution** +Describe the solution you'd like. Provide examples and describe how it works. Define any new terminology.