Skip to content

Commit

Permalink
chore: add new issue and PR templates according to the new spec proce…
Browse files Browse the repository at this point in the history
…ss (asyncapi#516)

* chore: add new issue and PR templates according to the new spec process

* Improve issue and pr templates

* Point to issue #1 on community repo

* Fix stawman PR template

* Add frontmatter to default issue template

* Add a single PR template
  • Loading branch information
fmvilas authored Mar 19, 2021
1 parent dbae6ac commit 4ecabf3
Show file tree
Hide file tree
Showing 8 changed files with 131 additions and 78 deletions.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: ""
about: ""
---

<!--
!!! IMPORTANT !!!
Before creating your issue:
* **Have a question?** Find community resources at https://github.com/asyncapi/community/issues/1.
* **Found an editing mistake?** Create a Pull Request with the edited fix. The Github UI allows you to edit files directly, find the source files at [asyncapi/spec/tree/master/spec](https://github.com/asyncapi/spec/tree/master/spec).
* **Improvements to documentation?** Head over to [asyncapi/website](https://github.com/asyncapi/website).
* **Feature request?** First read [asyncapi/spec/blob/master/CONTRIBUTING.md](https://github.com/asyncapi/spec/blob/master/CONTRIBUTING.md) and prefer creating a Pull Request!
-->
33 changes: 24 additions & 9 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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**
<!--
!!! IMPORTANT !!!
Before creating your issue:
* **Have a question?** Find community resources at https://github.com/asyncapi/community/issues/1.
* **Found an editing mistake?** Create a Pull Request with the edited fix. The Github UI allows you to edit files directly, find the source files at [asyncapi/spec/tree/master/spec](https://github.com/asyncapi/spec/tree/master/spec).
* **Improvements to documentation?** Head over to [asyncapi/website](https://github.com/asyncapi/website).
* **Feature request?** First read [asyncapi/spec/blob/master/CONTRIBUTING.md](https://github.com/asyncapi/spec/blob/master/CONTRIBUTING.md) and prefer creating a Pull Request!
-->

### 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.
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: 💡 Proposal (RFC 1)
about: See CONTRIBUTING.md
title: ""
labels: '💡 Proposal (RFC 1)'
assignees: ''
---

<!--
!!! IMPORTANT !!!
Before creating your issue:
* **Have a question?** Find community resources at https://github.com/asyncapi/community/issues/1.
* **Found an editing mistake?** Create a Pull Request with the edited fix. The Github UI allows you to edit files directly, find the source files at [asyncapi/spec/tree/master/spec](https://github.com/asyncapi/spec/tree/master/spec).
* **Improvements to documentation?** Head over to [asyncapi/website](https://github.com/asyncapi/website).
* **Feature request?** First read [asyncapi/spec/blob/master/CONTRIBUTING.md](https://github.com/asyncapi/spec/blob/master/CONTRIBUTING.md) and prefer creating a Pull Request!
-->
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Question
about: A question about the spec or processes
title: ""
labels: '❔ Question'
assignees: ''
---

<!--
!!! IMPORTANT !!!
Before creating your issue:
* **Have a question?** Find community resources at https://github.com/asyncapi/community/issues/1.
* **Found an editing mistake?** Create a Pull Request with the edited fix. The Github UI allows you to edit files directly, find the source files at [asyncapi/spec/tree/master/spec](https://github.com/asyncapi/spec/tree/master/spec).
* **Improvements to documentation?** Head over to [asyncapi/website](https://github.com/asyncapi/website).
* **Feature request?** First read [asyncapi/spec/blob/master/CONTRIBUTING.md](https://github.com/asyncapi/spec/blob/master/CONTRIBUTING.md) and prefer creating a Pull Request!
-->
46 changes: 0 additions & 46 deletions .github/ISSUE_TEMPLATE/review.md

This file was deleted.

23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/strawman.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: 💭 Strawman (RFC 0)
about: See CONTRIBUTING.md
title: ""
labels: '💭 Strawman (RFC 0)'
assignees: ''
---

<!--
!!! IMPORTANT !!!
Before creating your issue:
* **Have a question?** Find community resources at https://github.com/asyncapi/community/issues/1.
* **Found an editing mistake?** Create a Pull Request with the edited fix. The Github UI allows you to edit files directly, find the source files at [asyncapi/spec/tree/master/spec](https://github.com/asyncapi/spec/tree/master/spec).
* **Improvements to documentation?** Head over to [asyncapi/website](https://github.com/asyncapi/website).
* **Feature request?** First read [asyncapi/spec/blob/master/CONTRIBUTING.md](https://github.com/asyncapi/spec/blob/master/CONTRIBUTING.md) and prefer creating a Pull Request!
-->
18 changes: 18 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: ""
---

---

**Related issue(s):**

---

<!--
1. Make sure you craft a good description!
2. Is it a Strawman proposal (RFC 0)? Add the 💭 Strawman (RFC 0) label.
3. Is it a Proposal (RFC 1)? Add the 💡 Proposal (RFC 1) label.
4. Is it just an editorial fix, typo, or something that doesn't change the spec behavior? Add the ✏️ Editorial label.
-->

0 comments on commit 4ecabf3

Please sign in to comment.