Skip to content

docs: Update contributing guide regarding issue templates #2484

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

Merged
merged 1 commit into from
May 2, 2025

Conversation

aryan-dani
Copy link
Contributor

Updated CONTRIBUTING_GUIDE.md to clarify the use of YAML issue templates when creating new issues. This ensures the contribution guide accurately reflects the current process for submitting issues via the forms in the .github/ISSUE_TEMPLATE directory.

Closes #2483

Summary of testing strategy (including rationale)
for the feature or bug fix. Unit and/or integration
tests are expected for any behaviour change and
system tests should be considered for larger changes.

This is a documentation-only change. I have manually verified that the updated instructions in CONTRIBUTING_GUIDE.md are clear and the link to create a new issue works correctly.

Committer Checklist (excluded from commit message)

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation (including upgrade notes)

@aryan-dani aryan-dani changed the title Docs: Update contributing guide regarding issue templates docs: Update contributing guide regarding issue templates May 1, 2025
@aryan-dani
Copy link
Contributor Author

I know that this is the smallest change possible @daniel-y but this is my first PR request ever and i couldn't find a good-first-issue that i can solve. Let me know if any other changes required

@daniel-y
Copy link
Contributor

daniel-y commented May 2, 2025

Sounds good to me, thanks for your contribution. @aryan-dani

@aryan-dani
Copy link
Contributor Author

Thankyou so much, if there are any other actual problems i can help to solve please do let me know

@daniel-y
Copy link
Contributor

daniel-y commented May 2, 2025

Thankyou so much, if there are any other actual problems i can help to solve please do let me know

Of course, we'll create more good first issues next week. In the meantime, you can read the source code or our blog to learn more about AutoMQ before making deeper contributions.

@daniel-y daniel-y merged commit 8ab4414 into AutoMQ:main May 2, 2025
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request] Update CONTRIBUTING_GUIDE.md regarding issue templates
2 participants