Skip to content

Commit 33b1b6b

Browse files
authored
docs: add a few issue templates and a PR template (LEGO#91)
1 parent 6293caa commit 33b1b6b

File tree

3 files changed

+76
-0
lines changed

3 files changed

+76
-0
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ""
5+
labels: '🐞 Bug'
6+
assignees: ''
7+
---
8+
9+
<!--
10+
11+
!!! IMPORTANT !!!
12+
13+
Before creating your issue:
14+
15+
* **Have a question?** You can ask or find answers in the [discussions](https://github.com/LEGO/AsyncAPI.NET/discussions).
16+
17+
* **Found an editing mistake?** Create a Pull Request with the edited fix. The Github UI allows you to edit files directly.
18+
19+
* **Feature request?** First read [asyncapi/spec/blob/master/CONTRIBUTING.md](https://github.com/LEGO/AsyncAPI.NET/blob/main/CONTRIBUTING.md) and prefer creating a Pull Request!
20+
21+
-->
22+
23+
### Describe the bug
24+
A clear and concise description of what the bug is.
25+
26+
### To Reproduce
27+
Steps to reproduce the behavior:
28+
1. Create a document with '...'
29+
2. Try to change to '....'
30+
3. Try to validate the document doing '....'
31+
4. See error
32+
33+
### Expected behavior
34+
A clear and concise description of what you expected to happen.
35+
36+
### Sample document
37+
If applicable, add an AsyncAPI document illustrating the problem.
38+
39+
### Screenshots
40+
If applicable, add screenshots to help explain your problem.
41+
42+
### Additional context
43+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Question
3+
about: A question about the spec or processes
4+
title: ""
5+
labels: '❔ Question'
6+
assignees: ''
7+
---
8+
9+
<!--
10+
11+
!!! IMPORTANT !!!
12+
13+
Before creating your issue:
14+
15+
* **Have a question?** You can ask or find answers in the [discussions](https://github.com/LEGO/AsyncAPI.NET/discussions).
16+
17+
* **Found an editing mistake?** Create a Pull Request with the edited fix. The Github UI allows you to edit files directly.
18+
19+
* **Feature request?** First read [asyncapi/spec/blob/master/CONTRIBUTING.md](https://github.com/LEGO/AsyncAPI.NET/blob/main/CONTRIBUTING.md) and prefer creating a Pull Request!
20+
21+
-->
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## About the PR
2+
3+
### Changelog
4+
- Add: Added amazing features!
5+
- Remove: Removed tedious bugs!
6+
7+
### Related Issues
8+
- Closes #<issue-number>
9+
10+
<!--
11+
Ensure to write a good, detailed description.
12+
-->

0 commit comments

Comments
 (0)