diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..beb7c81a7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,20 @@ +--- +name: "" +about: "" +--- + + diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 8c7d32863..6d006c143 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,30 +1,45 @@ --- name: Bug report about: Create a report to help us improve -title: "[BUG] " -labels: bug +title: "" +labels: '🐞 Bug' assignees: '' - --- -**Describe the bug** + + +### Describe the bug A clear and concise description of what the bug is. -**To Reproduce** +### To Reproduce Steps to reproduce the behavior: 1. Create a document with '...' 2. Try to change to '....' 3. Try to validate the document doing '....' 4. See error -**Expected behavior** +### Expected behavior A clear and concise description of what you expected to happen. -**Sample document** +### Sample document If applicable, add an AsyncAPI document illustrating the problem. -**Screenshots** +### Screenshots If applicable, add screenshots to help explain your problem. -**Additional context** +### Additional context Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index f0f040cdd..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for the specification -title: "[FEATURE REQUEST] " -labels: feature request -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Can't it be tackled using specification extensions?** -Why do you think it should be part of the specification instead of creating a specification extension? - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. Please, provide one or more sample AsyncAPI documents demonstrating how it would look like if implemented. Don't worry about the quality of the proposal at this point, this is just to make it easier for everyone to understand what you're asking for. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or examples about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/proposal.md b/.github/ISSUE_TEMPLATE/proposal.md new file mode 100644 index 000000000..cebba376b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/proposal.md @@ -0,0 +1,23 @@ +--- +name: 💡 Proposal (RFC 1) +about: See CONTRIBUTING.md +title: "" +labels: '💡 Proposal (RFC 1)' +assignees: '' +--- + + diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 000000000..2fce0e1f5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,23 @@ +--- +name: Question +about: A question about the spec or processes +title: "" +labels: '❔ Question' +assignees: '' +--- + + diff --git a/.github/ISSUE_TEMPLATE/review.md b/.github/ISSUE_TEMPLATE/review.md deleted file mode 100644 index dda167dd3..000000000 --- a/.github/ISSUE_TEMPLATE/review.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -name: Version 2.0.0 review -about: Give feedback and suggest improvements of version 2.0.0. -title: "[2.0.0 REVIEW] " -labels: 'v2.0.0 review' -assignees: '' - ---- - -# AsyncAPI Review Document - -|Project name|Reviewers|Company|Spec version| -|------------|---------|-------|------------| -|{{PROJECT NAME}}|{{REVIEWER 1 NAME}}, {{REVIEWER 2 NAME}}|{{COMPANY}}|v2.0.0| - -## Our goals with this project are to: - 1. {{INSERT GOAL HERE}} - 2. {{INSERT GOAL HERE}} - -## We expect to: - 1. {{INSERT EXPECTATION}} - 2. {{INSERT EXPECTATION}} - -## We found the following challenges or difficulties: - - - -### 1. {{BRIEFLY DESCRIBE IT}} -{{EXPAND ON THE CHALLENGE OR DIFFICULTY YOU FOUND}} - -#### We think it can be solved by... -{{EXPLAIN ONE OR MORE POSSIBLE SOLUTIONS}} - -#### Overall, we think this challenge/difficulty is... - * [ ] A "nice to have". - * [ ] A blocker for us to adopt this version of the spec. - * [ ] Something that doesn't affect the specification. - - - -## Other thoughts? - -Please, let us know if there's something else you would like to tell us. - ---- -_AsyncAPI Initiative — (website: [asyncapi.org](https://asyncapi.org), twitter: [@AsyncAPISpec](https://twitter.com/AsyncAPISpec))_ \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/strawman.md b/.github/ISSUE_TEMPLATE/strawman.md new file mode 100644 index 000000000..ba159d4db --- /dev/null +++ b/.github/ISSUE_TEMPLATE/strawman.md @@ -0,0 +1,23 @@ +--- +name: 💭 Strawman (RFC 0) +about: See CONTRIBUTING.md +title: "" +labels: '💭 Strawman (RFC 0)' +assignees: '' +--- + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..d3e31407b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,18 @@ +--- +title: "" +--- + +--- + +**Related issue(s):** + +--- + + \ No newline at end of file