taipy icon indicating copy to clipboard operation
taipy copied to clipboard

docs: convert markdown issue templates to issue forms

Open Anmol-Baranwal opened this issue 1 year ago • 6 comments

closes #1234

Changes proposed

I've added five issue forms in total and removed existing markdown templates.

I've used the existing templates as inspiration (especially the acceptance criteria).

  • Documentation
  • Feature Request
  • Refactor Code/Feature Improvement
  • Bug Report
  • Other (to avoid creating blank issues) - discussion

You can see how these will preview on my fork branch. You cannot see it while creating an issue (which I've enabled) because it's in another branch and not in the main branch.

If you want to see how the final issue forms will look in general, then you can check this or this. I've contributed it myself a few months back.

Why Issue forms

  • This will give you a consistent info so it will be easier to check the issue.
  • Even a user with no markdown knowledge can easily fill up the form.

Note to reviewers

  1. Sections that are required are marked with * Asterisk.

For instance. required

  1. I've also added a bit of Markdown content to improve context.

  2. I've used labels of existing templates except for discussion and documentation. Let me know if any changes are necessary in that.


@jrobinAV Please suggest any necessary changes, and I will make them!

Anmol-Baranwal avatar Apr 26 '24 18:04 Anmol-Baranwal

@florian-vuillemot I've updated the placeholder as per suggestion and marked the conversation resolved.

Anmol-Baranwal avatar Apr 29 '24 06:04 Anmol-Baranwal

@FabienLelaquais I've made the changes and marked the suggestions as resolved. Let me know if it needs any other changes!

Anmol-Baranwal avatar May 03 '24 15:05 Anmol-Baranwal

Hi Team, if everything is okay, please review and merge this PR.

Anmol-Baranwal avatar May 10 '24 07:05 Anmol-Baranwal

The two other reviewers are currently on vacation. They should be back in a couple of days. I am waiting for a second approval, and once it's ok, I'll merge it.

Thank you again.

jrobinAV avatar May 13 '24 08:05 jrobinAV

Hi Team! Sorry for disturbing you during your vacation time. Please feel free to reply whenever you're available.

One of the tests failed due to a spelling error in documentation. Should I correct it, even though it will dismiss the reviews?

image

Let me know your decision. I'm unsure about the issue with the other one.

Have a great day!

Anmol-Baranwal avatar May 14 '24 11:05 Anmol-Baranwal

Hello,

Oh, right. If you can fix it, that would be great. Thank you.

jrobinAV avatar May 14 '24 15:05 jrobinAV

@jrobinAV I kind of missed it.

Anyway, I have updated it with the documentation label present in the repo.

image

I hope this works!

Let me know if you want me to fix anything else or if any test is failing.

Anmol-Baranwal avatar May 19 '24 19:05 Anmol-Baranwal