shesharpnl / .github

MIT License
1 stars 3 forks source link

feat: Comment Out Instructions in the Issue Templates #4

Closed adiati98 closed 1 year ago

adiati98 commented 1 year ago

Suggestion/Improvement

🌟 Hi there! We're excited to hear your suggestions and ideas for making this project better. Thank you for contributing to our community!

Description

After previewing a written issue, commenting out the questions/instuctions in the issue templates would give more clarity to read the issue.

Motivation

When a contributor doesn't delete the instructions when they write an issue, it makes harder for maintainers/triage team to review the issue. But commenting out the issue would not give any problems for contributors.

Screenshots

Below are examples screenshot of result before and after commenting out the instructions:

Before commenting out (read arrow pointing at the issue that contributors have written):

without comment

After commenting out:

comment out

Implementation (if applicable)

Comment out the instructions like example below:

<!-- Comment this out -->

Your Participation Matters

We appreciate your efforts to make this project more awesome! Your suggestions are valuable to us, and we'll review them as soon as possible.