diff --git a/.github/ISSUE_TEMPLATE/1_bug_report.yaml b/.github/ISSUE_TEMPLATE/1_bug_report.yaml new file mode 100644 index 000000000..550174861 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_bug_report.yaml @@ -0,0 +1,62 @@ +name: Bug Report +description: Report a bug or documentation error +title: "[Bug]: " +labels: ["🚨 new::bug"] +projects: ["deven-org/3"] +body: + - type: markdown + attributes: + value: | + Before reporting a bug or a documentation error, please [check if the issue already exists](https://github.com/deven-org/B01LER-Kitchen/issues). + + --- + + Thanks for taking the time to fill out this bug report! We will do our best to reply to new issues within a week. + - type: dropdown + id: bug-type + attributes: + label: What is affected? + description: You can select multiple options. + multiple: true + options: + - Component + - Accessibility + - Token System + - Documentation + - Other (please specify in the description) + - type: textarea + id: description + attributes: + label: Description + description: What happened? Also tell us, what did you expect to happen? + placeholder: "When I do ..., I would expect ..., instead ... happens." + validations: + required: true + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: Which steps do we need to take to reproduce this error? + value: | + 1. Step 1 + 2. ... + - type: input + id: version + attributes: + label: Affected version(s) + description: What version of B01LER are you running? If the issue was not affecting a previous version, which was it? + placeholder: "vX.X.X with issue, vX.X.X without issue" + - type: input + id: os-browser-env + attributes: + label: Operating system / Browser / Environment + description: "Which operating system and browser do you use? Please provide the version as well. If the bug affects a command-line tool, please add this information as well." + placeholder: "OS: macOS Sonoma 14.2.1 (23C71), Browser: Chrome 121.0.6167.85, Node: 18.17.0, yarn: 4.0.2" + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/deven-org/B01LER-Kitchen/blob/develop/CODE_OF_CONDUCT.md) + options: + - label: I agree to follow this project's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/2_feature_request.yaml b/.github/ISSUE_TEMPLATE/2_feature_request.yaml new file mode 100644 index 000000000..dc771d332 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_feature_request.yaml @@ -0,0 +1,29 @@ +name: Feature Request +description: Request a feature +title: "[Feature Request]: " +labels: ["🚨 new::enhancement"] +projects: ["deven-org/3"] +body: + - type: markdown + attributes: + value: | + Before opening a feature request, please [check if the request already exists](https://github.com/deven-org/B01LER-Kitchen/issues). + - type: textarea + id: description + attributes: + label: Description + description: Describe the feature you are requesting. Please provide key information like why the feature is needed, what the feature is and what value the feature creates. You can do this by using a user story template. + value: | + As a [persona], + I [want to], + [so that]. + validations: + required: true + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/deven-org/B01LER-Kitchen/blob/develop/CODE_OF_CONDUCT.md) + options: + - label: I agree to follow this project's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/3_custom_issue.yaml b/.github/ISSUE_TEMPLATE/3_custom_issue.yaml new file mode 100644 index 000000000..3c783f0a6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3_custom_issue.yaml @@ -0,0 +1,45 @@ +name: Issue Template +description: Create an issue +title: "[Component name] - [task summary]" +projects: ["deven-org/3"] +body: + - type: markdown + attributes: + value: | + Before creating an issue please [check if the issue already exists](https://github.com/deven-org/B01LER-Kitchen/issues). + - type: textarea + id: description + attributes: + label: Description / User story + description: Describe the issue here or formulate a user story. + value: | + As a [persona], + I [want to], + [so that]. + validations: + required: true + - type: textarea + id: criteria + attributes: + label: Acceptance Criteria + description: List the acceptance criteria that need to be met to solve the issue. + value: | + - [ ] Acceptance Criteria 1 + - [ ] ... + validations: + required: true + - type: textarea + id: info + attributes: + label: Additional information + description: Add relevant information here. + value: | + - ... + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/deven-org/B01LER-Kitchen/blob/develop/CODE_OF_CONDUCT.md) + options: + - label: I agree to follow this project's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 000000000..f71f915c7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Ask questions or give feedback + url: https://github.com/deven-org/B01LER-Kitchen/discussions + about: Start a discussion to ask questions or give feedback. diff --git a/.github/ISSUE_TEMPLATE/custom-bug-template.md b/.github/ISSUE_TEMPLATE/custom-bug-template.md deleted file mode 100644 index af6b79431..000000000 --- a/.github/ISSUE_TEMPLATE/custom-bug-template.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Custom bug template -about: Used for bugs -title: "[Component name] - [task description]" -labels: "\U0001F6A8 new::bug" -assignees: '' - ---- - -#### Step-by-Step Guide to reproduce - -1. _Step 1_ -2. ... - ----- -#### Bug Description / False Behaviour - -_Add description of the bug here._ - ----- -#### Correct Behaviour - -_Add description of the correct behaviour here._ - ----- -#### Testing - -_Check existing unit tests of the component(s) and adjust the tests to prevent this bug from occurring again in the future, if you see a way._ - ----- -#### Background -- _Add more background information here, if needed._ -- ... diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md deleted file mode 100644 index 0d4eaeae9..000000000 --- a/.github/ISSUE_TEMPLATE/custom.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: Custom issue template -about: Used for all kinds of issues -title: "[Component name] - [task description]" -labels: '' -assignees: '' - ---- - -#### Description / User Story - -_Describe the ticket here or formulate a user story as follows:_ - -**As** ... -**I need** ... -**so that** ... - - ----- -#### Acceptance Criteria -- [ ] _Acceptance criteria 1_ -- [ ] ... - - ----- -#### Background information -- _Add relevant information here_ -- ... diff --git a/doc/SUPPORT.md b/doc/SUPPORT.md new file mode 100644 index 000000000..6b9cc98c9 --- /dev/null +++ b/doc/SUPPORT.md @@ -0,0 +1,13 @@ +# Support + +## Browsers + +B01LER aims to support the latest two major versions of evergreen-browsers at the time of +each release. + + +## FAQ + +In case your question is not listed here, please ask the question by starting a discussion [here](https://github.com/deven-org/B01LER-Kitchen/discussions). + +Currently there are no FAQs yet. This will change as soon as we answered some questions.