Skip to content

Commit

Permalink
chore: add missing issues templates (#830)
Browse files Browse the repository at this point in the history
  • Loading branch information
Amzani authored Nov 6, 2023
1 parent 1c92cf3 commit a15d06b
Show file tree
Hide file tree
Showing 5 changed files with 63 additions and 1 deletion.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Bug report
about: Report a bug so we can fix and improve
labels: bug
---

#### Describe the bug
A clear and concise description of what the bug is.

#### How to Reproduce
Steps to reproduce the issue. Attach all resources that can help us understand the issue:

- Screenshots
- Link to GitHub repository with project that has issues
- Files that can help reproduce the issue, like your AsyncAPI file, either paste inside the issue in a code block or in a sharable [gist](https://gist.github.com/)

#### Expected behavior
A clear and concise description of what you expected to happen.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: true
contact_links:
- name: Project Communication
url: https://github.com/asyncapi/asyncapi/issues/115
about: Check out all the options to communicate with AsyncAPI community.
- name: Slack
url: https://www.asyncapi.com/slack-invite/
about: Don't open issues for questions or support, better talk to us on Slack first.
- name: AsyncAPI Website
url: https://www.asyncapi.com/
about: For more information about AsyncAPI visit our website.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Feature request
about: Suggest how we can improve
labels: enhancement
---

#### Reason/Context
Please try answering few of those questions
- Why we need this improvement?
- How will this change help?
- What is the motivation?


#### Description
Please try answering few of those questions
- What changes have to be introduced?
- Will this be a breaking change?
- How could it be implemented/designed?
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/pitch.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Pitch
description: 'Do you have an idea and a product enhancement? Time to pitch!'
title: '[PITCH]:'
labels: ['Pitch']
labels: ['pitch']
body:
- type: markdown
attributes:
Expand Down
15 changes: 15 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Thank you for your contribution. Before you submit the pull request:
1. Follow our contribution guidelines
2. Test your changes and attach their results to the pull request.
3. Update the relevant documentation.
-->

**Description**

- ...
- ...
- ...

**Related issue(s)**
<!-- If you refer to a particular issue, provide its number, otherwise, remove this section.
For example, `Resolves #123`, `Fixes #43`, or `See also #33`. The `See also #33` option will not automatically close the issue after the PR merge. -->

0 comments on commit a15d06b

Please sign in to comment.