CatsInTech / GitHub-ReadMe

This is a React Project where you can customise your GitHub ReadMe with all the available cool things.
http://githubreadme.co/
MIT License
52 stars 90 forks source link

Create an Issue Template #1

Closed praveenscience closed 1 year ago

praveenscience commented 1 year ago

As a part of GSSoC 23, I would like someone to create an Issue Template that gives the following choices.

  1. New Feature (Landing Page)
  2. New Feature (App)
  3. Bug (Landing Page)
  4. Bug (App)
  5. New Component (App)

And it should automatically give the default GSSoC Label. Please explain how you're planning to do it while you wanna grab this issue.

dakshsinghrathore commented 1 year ago

Hey @praveenscience, here is an issue template.👇

Issue Description

Type of Issue

Please select the type of issue from the following choices:

Additional Details

Please provide any additional details or context about the issue.

Labels

To automatically assign a label to an issue in GitHub, you can make use of GitHub Actions. Here's how you can set it up:👇

  1. Click on the "Actions" tab at the top of the repository.
  2. Click on the "Set up a workflow yourself" or "New workflow" button.
  3. Create a new YAML file auto_label.yml and paste the following code into it:👇

name: Auto Label Issue on: issues: types: [opened]

jobs: labelIssue: runs-on: ubuntu-latest steps:

  1. This workflow will trigger whenever a new issue is opened (types: [opened]).
  2. It checks if the issue title contains the string "GSSoC23" using grep. If the string is found, it sets the output contains_gssoc23 to '1'.
  3. If the contains_gssoc23 output is '1', it adds the label "GSSoC23" to the issue using the actions-ecosystem/action-add-labels action.
  4. Save the changes to the YAML file. Now, whenever a new issue is created with "GSSoC23" in its title, the "GSSoC23" label will be automatically assigned to it.

Here is an image of the code you need to paste 👇

image

Can you please assign this issue to me !

praveenscience commented 1 year ago

It's yours @DSR1729! 💪🏻

AmanJain18 commented 1 year ago

I think instead of giving choice to tick check box ✅ we can create different issue template of respective Issues, so that we can set content requirements as per issues. Eg: (Bug should have a mandatory Screenshot section for better understanding..., Step to reproduce, etc ) Wherever required

@praveenscience

dakshsinghrathore commented 1 year ago

Hey @praveenscience here is the PREVIEW of my changes in the contributing.md file, suggest me changes that you want to see init !! Also I have been trying to contact you on linkedIn, inorder to get your Whatsapp, no 🙂

Screenshot 2023-05-27 at 16-42-52 DSR1729_GitHub-ReadMe This is a React Project where you can customise your GitHub ReadMe with all the available cool things

praveenscience commented 1 year ago

@AmanJain18 Kindly try it out! Let's make it that way, that was the expected one. 💪🏻

AmanJain18 commented 1 year ago

@AmanJain18 Kindly try it out! Let's make it that way, that was the expected one. 💪🏻

Yes sure, Just let me know what Mandatory this to be asked while creating issue... Generally it has this structure:- Bug Description Current behaviour Expected behaviour reproduction StepS Screenshort term of code of conduct...

praveenscience commented 1 year ago

Give the first pass based on other projects, let's improve on top of it... 😊

AmanJain18 commented 1 year ago

This issue is completed and reslove mark it as close...

praveenscience commented 1 year ago

Resolved! Thanks! 😊