Skip to content

Commit

Permalink
Improve issue and pr templates
Browse files Browse the repository at this point in the history
  • Loading branch information
fmvilas committed Mar 16, 2021
1 parent 1a306e2 commit 3535538
Show file tree
Hide file tree
Showing 9 changed files with 176 additions and 4 deletions.
6 changes: 5 additions & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
### IMPORTANT
<!--
!!! IMPORTANT !!!
Before creating your issue:
Expand All @@ -9,3 +11,5 @@ Before creating your issue:
* **Improvements to documentation?** Head over to [asyncapi/website](https://www.github.com/asyncapi/website).
* **Feature request?** First read [asyncapi/spec/blob/master/CONTRIBUTING.md](https://www.github.com/asyncapi/spec/blob/master/CONTRIBUTING.md) and prefer creating a Pull Request!
-->
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
name: Bug report
about: Create a report to help us improve
title: ""
labels: '🐞 Bug'
assignees: ''
---

<!--
!!! IMPORTANT !!!
Before creating your issue:
* **Have a question?** Find community resources at [asyncapi/community](https://www.github.com/asyncapi/community).
* **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://www.github.com/asyncapi/spec/tree/master/spec).
* **Improvements to documentation?** Head over to [asyncapi/website](https://www.github.com/asyncapi/website).
* **Feature request?** First read [asyncapi/spec/blob/master/CONTRIBUTING.md](https://www.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
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
A clear and concise description of what you expected to happen.

### Sample document
If applicable, add an AsyncAPI document illustrating the problem.

### Screenshots
If applicable, add screenshots to help explain your problem.

### Additional context
Add any other context about the problem here.
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 [asyncapi/community](https://www.github.com/asyncapi/community).
* **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://www.github.com/asyncapi/spec/tree/master/spec).
* **Improvements to documentation?** Head over to [asyncapi/website](https://www.github.com/asyncapi/website).
* **Feature request?** First read [asyncapi/spec/blob/master/CONTRIBUTING.md](https://www.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 [asyncapi/community](https://www.github.com/asyncapi/community).
* **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://www.github.com/asyncapi/spec/tree/master/spec).
* **Improvements to documentation?** Head over to [asyncapi/website](https://www.github.com/asyncapi/website).
* **Feature request?** First read [asyncapi/spec/blob/master/CONTRIBUTING.md](https://www.github.com/asyncapi/spec/blob/master/CONTRIBUTING.md) and prefer creating a Pull Request!
-->
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 [asyncapi/community](https://www.github.com/asyncapi/community).
* **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://www.github.com/asyncapi/spec/tree/master/spec).
* **Improvements to documentation?** Head over to [asyncapi/website](https://www.github.com/asyncapi/website).
* **Feature request?** First read [asyncapi/spec/blob/master/CONTRIBUTING.md](https://www.github.com/asyncapi/spec/blob/master/CONTRIBUTING.md) and prefer creating a Pull Request!
-->
3 changes: 0 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md

This file was deleted.

19 changes: 19 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/editorial.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: ✏️ Editorial
about: See CONTRIBUTING.md
title: ""
labels: '✏️ Editorial'
assignees: ''
---

---

**Related issue(s):**

---

<!--
Make sure you craft a good description!
-->
19 changes: 19 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: 💡 Proposal (RFC 1)
about: See CONTRIBUTING.md
title: ""
labels: '💡 Proposal (RFC 1)'
assignees: ''
---

---

**Related issue(s):**

---

<!--
Make sure you craft a good description!
-->
19 changes: 19 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/strawman.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: 💡 Proposal (RFC 1)
about: See CONTRIBUTING.md
title: ""
labels: '💡 Proposal (RFC 1)'
assignees: ''
---

---

**Related issue(s):**

---

<!--
Make sure you craft a good description!
-->

0 comments on commit 3535538

Please sign in to comment.