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.

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

Need for Issue and Pull Request Templates #362

Open
DarikshaAnsari opened this issue Jun 2, 2024 · 8 comments
Open

Need for Issue and Pull Request Templates #362

DarikshaAnsari opened this issue Jun 2, 2024 · 8 comments
Assignees
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@DarikshaAnsari
Copy link

There is a need to create standardized templates for both issues and pull requests (PRs) in this repository to enhance the consistency and quality of contributions.
Currently, the repository lacks standardized templates for issues and PRs. This can lead to inconsistent reporting of issues and submission of PRs, making it challenging to understand the context, reproduce problems, and review changes effectively.

@marcelamelara
Copy link
Contributor

Hi @DarikshaAnsari ! I'm totally in favor of having issue templates. I will only say that this is primarily a spec repo, not a code repo, so the issue/PR templates would need to be tailored to that. But we'd absolutely be happy about contributions here, if you have the time and interest.

@marcelamelara marcelamelara added good first issue Good for newcomers help wanted Extra attention is needed labels Jun 12, 2024
@tannerjones4075
Copy link
Contributor

tannerjones4075 commented Jun 13, 2024

Creating a contributing guide could also help and provide consistency and provide information to those wanting to contribute e.g. https://github.com/asyncapi/spec/blob/master/CONTRIBUTING.md. Found some examples of spec issue templates: https://github.com/asyncapi/spec/tree/master/.github/ISSUE_TEMPLATE

@marcelamelara
Copy link
Contributor

Thanks for sharing @tannerjones4075 ! I'll have a look.

We already have contributing guidelines for predicates, but I agree that a broader contributing guide would help clarify what we are/aren't looking for in terms of contributions.

@DarikshaAnsari
Copy link
Author

@tannerjones4075 If you want to solve this issue, I am more than happy to hand it over to you.

@ayushrakesh
Copy link

@DarikshaAnsari I want to work on this issue, please assign to me.

@marcelamelara
Copy link
Contributor

I want to make sure folks aren't doing redundant work.

@tannerjones4075 To clarify, were you planning to submit a PR for this issue? Otherwise, we can assign this to @ayushrakesh .

@tannerjones4075
Copy link
Contributor

tannerjones4075 commented Jun 20, 2024

Yes, I plan on working on it.

@marcelamelara
Copy link
Contributor

Thanks @tannerjones4075 !! I'll assign this to you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants