diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..1a631a06 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,35 @@ +name: 🐛 Bug Report +description: File a bug report. +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: bug-description + attributes: + label: What happened? + description: Please describe the bug. + placeholder: Description of the bug. + validations: + required: true + - type: textarea + id: steps-to-reproduce + attributes: + label: What are the steps to reproduce? + description: Please describe the steps to reproduce the bug. + placeholder: | + Step 1: ... + Step 2: ... + Step 3: ... + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: What is the expected behavior? + description: Please describe the behavior you expect of Shape Docs. + placeholder: I expect that Shape Docs would... + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..ab639056 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,37 @@ +name: ✨ Feature Request +description: Suggest an idea for this project +labels: ["feature"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request! + - type: textarea + id: problem + attributes: + label: Is your feature request related to a problem? + description: A clear and concise description of what the problem is. + placeholder: Yes, the problem is that... + validations: + required: true + - type: textarea + id: solution + attributes: + label: What solution would you like? + description: A clear and concise description of what you want to happen. + placeholder: I would like that... + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: What alternatives have you considered? + description: A clear and concise description of any alternative solutions or features you've considered. + placeholder: I have considered to... + validations: + required: true + - type: textarea + id: context + attributes: + label: Any additional context? + description: Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 00000000..6e26497f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,17 @@ +name: ❓ Question +description: Ask a question about this project +labels: ["question"] +body: + - type: textarea + id: question + attributes: + label: Your Question + description: A clear and concisely formulated question. + placeholder: I'd like to ask... + validations: + required: true + - type: textarea + id: context + attributes: + label: Any additional context? + description: Add any other context or screenshots about the question request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..4739b265 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,16 @@ + + +## Description + + +## Motivation and Context + + + +## Screenshots (if appropriate): + +## Types of changes + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)