taipy icon indicating copy to clipboard operation
taipy copied to clipboard

docs: convert markdown templates to issue forms

Open Anmol-Baranwal opened this issue 2 years ago • 1 comments

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.

Anmol-Baranwal avatar Apr 25 '24 14:04 Anmol-Baranwal

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.

jrobinAV avatar Apr 25 '24 15:04 jrobinAV