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

docs: convert markdown templates to issue forms #1234

Closed
Anmol-Baranwal opened this issue Apr 25, 2024 · 1 comment · Fixed by #1238
Closed

docs: convert markdown templates to issue forms #1234

Anmol-Baranwal opened this issue Apr 25, 2024 · 1 comment · Fixed by #1238
Assignees
Labels
📄 Documentation Internal or public documentation 🆘 Help wanted Open to participation from the community 📈 Improvement Improvement of a feature. 🟨 Priority: Medium Not blocking but should be addressed

Comments

@Anmol-Baranwal
Copy link
Contributor

I'm opening a blank issue because these refer to docs and don't change the existing functionality.

Proposed Changes

  1. Convert the issue templates to YML form to simplify the process for contributors and remove the markdown templates (.yml).

    • Issue forms are more user-friendly than Markdown templates, especially for contributors unfamiliar with Markdown syntax. They can fill out the fields and provide the requested information easily.

    • Issue forms standardize the information provided by contributors, reducing the need for follow-up questions and clarifications.

    • With issue forms, all issues are created in a consistent format, making it easier for maintainers to review and respond quickly.

    You can refer to this example to see how an issue form looks.

  2. Add more issue templates.

Currently, there are only 3 issue templates, but there can be more templates for documentation, refactoring the codebase, or discussion. Let me know if you want me to add any of these or something specific.

image


I'd love to contribute to this. Please assign me, and I'll make a PR.

@jrobinAV jrobinAV added 📄 Documentation Internal or public documentation 🆘 Help wanted Open to participation from the community 📈 Improvement Improvement of a feature. 🟨 Priority: Medium Not blocking but should be addressed labels Apr 25, 2024
@jrobinAV
Copy link
Member

Hello @Anmol-Baranwal.

Thank you for your contribution. We would love to see your proposal for new templates. That would be great.

I am just assigning the issue to you. Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 Documentation Internal or public documentation 🆘 Help wanted Open to participation from the community 📈 Improvement Improvement of a feature. 🟨 Priority: Medium Not blocking but should be addressed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants