Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 7 commits into from
Mar 19, 2021
Merged

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

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1a306e2
chore: add new issue and PR templates according to the new spec process
fmvilas Mar 16, 2021
3535538
Improve issue and pr templates
fmvilas Mar 16, 2021
47acda1
Point to issue #1 on community repo
fmvilas Mar 18, 2021
7174aa5
Fix stawman PR template
fmvilas Mar 18, 2021
8fa4a3c
Add frontmatter to default issue template
fmvilas Mar 18, 2021
e4fb4f7
Add a single PR template
fmvilas Mar 18, 2021
75ea328
Merge branch 'master' into new-issue-and-pr-templates
fmvilas Mar 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!--

!!! IMPORTANT !!!

Before creating your issue:

* **Have a question?** Find community resources at [asyncapi/community](https://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://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
View file
Open in desktop
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 [asyncapi/community](https://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://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
View file
Open in desktop

This file was deleted.

23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/proposal.md
View file
Open in desktop
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://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://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
View file
Open in desktop
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://github.com/asyncapi/community).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you have some plans to extend https://github.com/asyncapi/community with some resources? maybe better link here asyncapi/community#1 ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good point. I'll change it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed!


* **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
View file
Open in desktop

This file was deleted.

23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/strawman.md
View file
Open in desktop
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://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://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!

-->
19 changes: 19 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/editorial.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: 💡 Proposal (RFC 1)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did you check how those templates and prs would show up? on some test repo? Last time I checked GH supported only one PR template

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, I haven't. And thanks for bringing the comment up. This file is wrong. It says "strawman" but in fact, it's a proposal RFC 1.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can choose the template to use by adding the ?template=issue_template.md. Unfortunately, there is no UI for that yet.

More info at https://docs.github.com/en/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters#supported-query-parameters

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replaced Proposal (RFC 1) with Strawman (RFC 0).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@smoya how would it work with PR, no example in docs? I think we need one template with all sections and contributor just need to leave the one that is relevant

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it's gonna be always the same template, yes one should be enough. Otherwise you can also set a default one but also have more templates people can use (by adding the query parameter)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the thing is that if for now, the only way to use different PR templates is to use some mysterious query param, it is not very helpful. I mean who would even remember the names of templates anyway 🤷🏼 this is why better to consolidate all into one template that will always show up

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, makes sense as the ux doesnt help this time 👍

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I'll remove them. It doesn't make sense with the PR workflow if there's no UI for that.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about now?

about: See CONTRIBUTING.md
title: ""
labels: '💡 Proposal (RFC 1)'
assignees: ''
---

---

**Related issue(s):**

---

<!--

Make sure you craft a good description!

-->