chore: add new issue and PR templates according to the new spec process #516
Conversation
|
Is it feasible to do the PR template as a checkbox and Q/A thing? Like for example:
I feel like this kind of thing forces people to actually read the PR guidelines, and helps with the PR format. OR is it how the spec does it? If it is, please ignore my idea. |
|
This is more or less what we have right now but after triaging some issues it probably still makes sense to have this format of Q/A 👍 |
|
What about now? Many more options 😅 |
|
Yeah, that's good 😆 |
.github/ISSUE_TEMPLATE/question.md
Outdated
|
|
||
| Before creating your issue: | ||
|
|
||
| * **Have a question?** Find community resources at [asyncapi/community](https://github.com/asyncapi/community). |
There was a problem hiding this comment.
you have some plans to extend https://github.com/asyncapi/community with some resources? maybe better link here asyncapi/community#1 ?
There was a problem hiding this comment.
That's a good point. I'll change it.
| @@ -0,0 +1,19 @@ | |||
| --- | |||
| name: 💡 Proposal (RFC 1) | |||
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
You can choose the template to use by adding the ?template=issue_template.md. Unfortunately, there is no UI for that yet.
There was a problem hiding this comment.
Replaced Proposal (RFC 1) with Strawman (RFC 0).
There was a problem hiding this comment.
@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
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Yup, makes sense as the ux doesnt help this time 👍
There was a problem hiding this comment.
Ok, I'll remove them. It doesn't make sense with the PR workflow if there's no UI for that.
|
Kudos, SonarCloud Quality Gate passed!
|
|
🎉 This PR is included in version 1.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
It is actually not included in the release. This was an unintentional release caused by the release automation initial run. 1.0 version of the spec was released a long time ago. The release mentioned by the bot was removed. |
|
🎉 This PR is included in version 2.1.0-2021-06-release.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 2.1.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
|
Not included in release 2.1 yet, 2.1 was mistakenly triggered by our automation. |
|
🎉 This PR is included in version 2.1.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Description
This PR removes the previous issue templates and creates a new one for issues and another for pull requests. They give you hints on how to contribute according to the new spec process.
Related issues
#511