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

Update blank issue form with dependency #2904

Closed
17 tasks done
JessicaLucindaCheng opened this issue Mar 1, 2022 · 14 comments · Fixed by #3717 or #3809
Closed
17 tasks done

Update blank issue form with dependency #2904

JessicaLucindaCheng opened this issue Mar 1, 2022 · 14 comments · Fixed by #3717 or #3809
Assignees
Labels
Complexity: Medium Feature: Administrative Administrative chores etc. role: front end Tasks for front end developers size: 0.25pt Can be done in 0.5 to 1.5 hours Status: Updated No blockers and update is ready for review

Comments

@JessicaLucindaCheng
Copy link
Member

JessicaLucindaCheng commented Mar 1, 2022

Dependency

Overview

We want to make the title, description, and format of the Blank Issue form clear that it is for issues with dependencies so that it will be easier and quicker to pick an issue template and write an issue. For this issue, we will update the title and description, and move the dependency section to the top of the form.

Details

The screenshots below were taken by viewing the form on GitHub. (See the last Action Item for detailed instructions on how to do this.)

Click here to see a screenshot of the current form

current-form

Click here to see a screenshot of the desired updated form

desired form

Action Items

In .github/ISSUE_TEMPLATE/blank-issue-form.yml on your local computer/IDE,

  • Move
      - type: dropdown
        id: dependency
        attributes:
          label: Is there a dependency?
          options:
            - "Yes"
            - "No"
        validations:
          required: true
      - type: textarea
        id: dependency-explanation
        attributes:
          label: If Yes, please explain
    
    to right below body:
    name: 'Blank Issue '
    description: 'Standard HackforLA issue template '
    
    body:
    
  • Change
    name: 'Blank Issue '
    description: 'Standard HackforLA issue template'
    
    to
    name: 'Blank Issue Form with Dependency'
    description: 'Standard HackforLA issue form with dependency'
    
  • To check the form works correctly
    • Push the changes to your remote forked repo's topic branch on GitHub
    • In your remote forked repo on GitHub,
      • You are going to temporarily change the default branch from gh-pages to your topic branch. (See the link in the Resources/Instructions section for more documentation on how to do this.)
      • Then, check you have issues enabled in your forked repo by
        • Going to the Settings tab and then select General in the left menu.
        • On the right side of your screen, scroll until you see the Issues checkbox under the Features section. Make sure the checkbox is checked.
          Click here to see what it looks like when issues are enabled in a repo
        • You should now see the Issues tab in your forked repo
      • Now, open an issue within your repo to test out the form you just edited by
        • Going to the Issues tab and clicking the New issue button.
        • Then select Getting Started button for Blank Issue Form with Dependency
        • You should now be able to test out the form and make sure everything functions as expected.
  • Once you're done, in your remote forked repo on GitHub, remember to change your default branch back to gh-pages.
  • Do items in comment below to finish the issue

Resources/Instructions

@JessicaLucindaCheng JessicaLucindaCheng added role: front end Tasks for front end developers P-Feature: Getting Started https://www.hackforla.org/getting-started size: 1pt Can be done in 4-6 hours labels Mar 1, 2022
@github-actions

This comment was marked as resolved.

@JessicaLucindaCheng JessicaLucindaCheng changed the title DRAFT: Change headers with p HTML tag to header HTML tags on Getting Started Page DRAFT: Figure out if title classes can be used for header HTML tags on Getting Started Page Apr 2, 2022
@JessicaLucindaCheng JessicaLucindaCheng changed the title DRAFT: Figure out if title classes can be used for header HTML tags on Getting Started Page DRAFT: Update blank issue form with dependency Apr 8, 2022
@JessicaLucindaCheng JessicaLucindaCheng added Feature: Administrative Administrative chores etc. Dependency An issue is blocking the completion or starting of another issue Complexity: Small Take this type of issues after the successful merge of your second good first issue size: 0.5pt Can be done in 3 hours or less and removed P-Feature: Getting Started https://www.hackforla.org/getting-started size: 1pt Can be done in 4-6 hours labels Apr 8, 2022
@JessicaLucindaCheng JessicaLucindaCheng changed the title DRAFT: Update blank issue form with dependency Update blank issue form with dependency May 25, 2022
@JessicaLucindaCheng JessicaLucindaCheng added Draft Issue is still in the process of being created and removed Draft Issue is still in the process of being created labels Sep 12, 2022
@hackforla hackforla deleted a comment from github-actions bot Sep 30, 2022
@JessicaLucindaCheng JessicaLucindaCheng added ready for dev lead Issues that tech leads or merge team members need to follow up on Draft Issue is still in the process of being created Ready for Prioritization and removed Dependency An issue is blocking the completion or starting of another issue ready for dev lead Issues that tech leads or merge team members need to follow up on Draft Issue is still in the process of being created labels Oct 31, 2022
@bishrfaisal bishrfaisal added this to the 08. Team workflow milestone Nov 6, 2022
@github-actions github-actions bot added the Status: Updated No blockers and update is ready for review label Nov 11, 2022
@hackforla hackforla deleted a comment from github-actions bot Nov 27, 2022
@ExperimentsInHonesty
Copy link
Member

@ExperimentsInHonesty
Copy link
Member

If we have two versions of the form. One with Dependency and one without, why does it ask you on the dependency one if you have a dependency?

image

with dependency
without dependency

@ExperimentsInHonesty
Copy link
Member

ExperimentsInHonesty commented Nov 27, 2022

Change the following section items

"Is there a dependency?"

  1. Please remove the YES/NO question

"If Yes, please explain"

  1. Change the title of text area from If Yes, please explain to Add Dependencies (ideally by issue #)
  2. Inside the text area add the default text
    - [ ]

@ExperimentsInHonesty ExperimentsInHonesty added Complexity: Medium size: 0.25pt Can be done in 0.5 to 1.5 hours and removed Complexity: Small Take this type of issues after the successful merge of your second good first issue size: 0.5pt Can be done in 3 hours or less labels Nov 27, 2022
@Adastros Adastros self-assigned this Nov 29, 2022
@github-actions
Copy link

Hi @Adastros, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:-
i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?)
ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

@Adastros
Copy link
Member

Availability this week (PST): 9 - 11 PM 29NOV22 , 30NOV22
ETA: 11PM 30NOV22

@ExperimentsInHonesty
Copy link
Member

@Adastros I moved this to the in progress column. Please do that in future when you self assign

@Adastros
Copy link
Member

Adastros commented Dec 1, 2022

Won't be able to finish tonight. Currently asking a dev lead a question I had while working on this issue.

@Adastros
Copy link
Member

Adastros commented Dec 6, 2022

Hi @ExperimentsInHonesty, I was working on the issue and wanted to get your thoughts on updating the issue template so that it more closely matches the structure of issue #2775 and #3132. Shout out to @JessicaLucindaCheng for helping me out. Below are some images to visualize the changes.

The images with the proposed changes moves the text area title Add Dependencies (ideally by issue #) to the description under the title and uses Dependency as the title instead. The main goal is to structure it similar to issue #2775 and #3132 while making the issue form itself more uniform. It also makes it a bit more convenient having it structured that way so that the user doesn't have to re-edit the issue after submitting it to rename the Dependency section of the issue.

Issue form with previous feedback implemented

Before submitting issue

Image

After submitting issue

Image

Issue form with proposed changes

Before submitting issue

Image

After submitting issue

Image

@Adastros Adastros added the Status: Help Wanted Internal assistance is required to make progress label Jan 8, 2023
@ExperimentsInHonesty
Copy link
Member

The proposed changes are better. do those

@Adastros Adastros removed the Status: Help Wanted Internal assistance is required to make progress label Jan 10, 2023
@Adastros
Copy link
Member

Availability (PST): 9 - 11 PM 10JAN23
ETA: 11PM 10JAN23

@ExperimentsInHonesty
Copy link
Member

good job!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Medium Feature: Administrative Administrative chores etc. role: front end Tasks for front end developers size: 0.25pt Can be done in 0.5 to 1.5 hours Status: Updated No blockers and update is ready for review
Projects
6 participants