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 issue templates to issue forms #1238

Merged
merged 7 commits into from
May 22, 2024

Conversation

Anmol-Baranwal
Copy link
Contributor

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!

@florian-vuillemot florian-vuillemot added the 📄 Documentation Internal or public documentation label Apr 29, 2024
@Anmol-Baranwal
Copy link
Contributor Author

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

jrobinAV
jrobinAV previously approved these changes Apr 30, 2024
Copy link
Member

@FabienLelaquais FabienLelaquais left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mainly minor typographical change requests for better homogeneity.
Great work!

.github/ISSUE_TEMPLATE/bug-report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug-report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug-report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug-report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug-report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/refactor-code.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug-report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/documentation.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature-request.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/other.yml Outdated Show resolved Hide resolved
@Anmol-Baranwal
Copy link
Contributor Author

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

jrobinAV
jrobinAV previously approved these changes May 3, 2024
Copy link
Member

@jrobinAV jrobinAV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @Anmol-Baranwal for your help.

@Anmol-Baranwal
Copy link
Contributor Author

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

@jrobinAV
Copy link
Member

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.

@Anmol-Baranwal
Copy link
Contributor Author

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!

@jrobinAV
Copy link
Member

Hello,

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

@Anmol-Baranwal
Copy link
Contributor Author

@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.

Copy link
Member

@florian-vuillemot florian-vuillemot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job thanks!

Copy link
Member

@FabienLelaquais FabienLelaquais left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks really good! Thanks!!

@jrobinAV jrobinAV merged commit 9f854e8 into Avaiga:develop May 22, 2024
150 of 151 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 Documentation Internal or public documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: convert markdown templates to issue forms
4 participants