abhijeetnishal / URLShortener

URL Shortener Deployed Link 👇🏻
https://urlsrtner.vercel.app
MIT License
37 stars 59 forks source link

Add templates for issues #10

Closed sanjay-kv closed 4 months ago

sanjay-kv commented 4 months ago

Issue templates are very helpful for a collaboration repo. When users identify a bug or want to add a new feature, you can provide templates so you can collect all the pertinent information you need to fix a bug or add a new feature.

We recommend creating a “Report Bug” and “Feature Request” issue template. you can refer this: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository

Some suggested prompts/questions you can add to a “Report Bug” template are:

Briefly describe the bug What is the expected behavior? Please provide step by step instructions on how to reproduce the bug Some suggested prompts/questions you can add to a “Feature Request” issue template are:

Briefly describe your feature request What problem is this feature trying to solve? How do we know when the feature is complete?

Reference: https://github.com/Recode-Hive/Stackoverflow-Analysis/issues/new/choose Click on Get Started button and copy the template to yours.

officeneerajsaini commented 3 months ago

Describe the bug We should update the issue template. We can add more new things like emoji, tags for issues, and titles for every issue, like Docs:, Feat:, Bug:. This way, we can understand the purpose of the issue raised by just seeing the title.

Expected behavior We can see all issues with a good title so we can easily understand the purpose for which the issue was created.

Screenshots

Screenshot from 2024-05-16 14-31-10

Screenshot from 2024-05-16 14-34-37

@abhijeetnishal , I'd like to work on this issue under GSSOC. Could you please add the necessary label and tag to the issue and assign it to me?