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

Creating issues to Add Missing Labels to Issue Templates #4307

Closed
30 tasks done
jdingeman opened this issue Mar 29, 2023 · 18 comments
Closed
30 tasks done

Creating issues to Add Missing Labels to Issue Templates #4307

jdingeman opened this issue Mar 29, 2023 · 18 comments
Labels
Complexity: Large epic Feature: Board/GitHub Maintenance Project board maintenance that we have to do repeatedly Feature: Onboarding/Contributing.md Issue Making: Level 4 Create an Epic Issue, and it's Level 2 or 3 issues role: back end/devOps Tasks for back-end developers role: dev leads Tasks for technical leads and/or merge team members size: 2pt Can be done in 7-12 hours

Comments

@jdingeman
Copy link
Member

jdingeman commented Mar 29, 2023

Dependencies

Overview

Developers have noticed that the GitHub bot will remove a label if a dev who creates an issue adds a label immediately after clicking "Submit new issue." We need to add the labels from the Missing series to the Issue Templates to prevent the GitHub bot from removing the labels, since the labels will already be set.

Action Items

  • This issue should only be assigned to a lead
  • In the Dependency section of this issue, click on each item to create the issue with the correct name (one at a time)
    • Paste the body template (1 or 2) from below into the issue and customize from the HLFA site: Audit: New Issue Template labels spreadsheet (see resources)
      • [ISSUE TEMPLATE YML] will be replaced with the corresponding issue template name
      • [INSERT CONTENT FROM SHEET] will be replaced with the current line and new line values in the spreadsheet
    • Add the labels good first issue size: 0.5pt role: front end role: back end/devOps, Feature: Board/GitHub Maintenance, ready for dev lead
  • Once all necessary issues have been created
    • remove the subheadings that say #### Issues that use template 1 and #### Issues that use template 2
    • add a dependency label
    • move this issue to the Ice Box column
  • If all the dependency issues are closed, remove the dependency label, move this issue from the Ice Box to the In Progress column, and close this issue.

Resources/Instructions

Body Template 1

### Prerequisite
1. Be a member of Hack for LA. (There are no fees to join.) If you have not joined yet, please follow the steps on our [Getting Started page](https://www.hackforla.org/getting-started) and attend an onboarding session.
2. Please make sure you have read our **[Hack for LA Contributing Guide](https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.md)** before you claim/start working on an issue.
### Overview
As developers, we need to add the labels from the [Missing series](https://github.com/hackforla/website/wiki/How-to-read-and-interpret-labels#missing-series) so that we can avoid the GitHub bot taking off the labels when devs add them to issues.
### Action Items
- [ ] Navigate to `.github/ISSUE_TEMPLATE/[ ISSUE TEMPLATE YML ]`
- [ ] Add the following line under the description field
   ```
   labels: ['role missing', 'Complexity: Missing', 'Feature Missing', 'size: missing','Draft']
   ```
**For PM, Merge Team, or Tech Lead**
- [ ] Once the pull request associated with this issue is approved and merged, please update and edit epic #4307 by
  - [ ] Checking off the dependency for this issue
  - [ ] If all dependencies are checked off, please move issue to the New Issue Approval column and remove the Dependency label

#### File and Code links you will need to work on this issue
- Directory to find the page in once you have it in your IDE: `.github/ISSUE_TEMPLATE/[ ISSUE TEMPLATE YML ]`
- This issue is part of epic #4307

Body Template 2

### Prerequisite
1. Be a member of Hack for LA. (There are no fees to join.) If you have not joined yet, please follow the steps on our [Getting Started page](https://www.hackforla.org/getting-started) and attend an onboarding session.
2. Please make sure you have read our **[Hack for LA Contributing Guide](https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.md)** before you claim/start working on an issue.
### Overview
As developers, we need to add the labels from the [Missing series](https://github.com/hackforla/website/wiki/How-to-read-and-interpret-labels#missing-series) so that we can avoid the GitHub bot taking off the labels when devs add them to issues.
### Action Items
- [ ] Navigate to `.github/ISSUE_TEMPLATE/[ ISSUE TEMPLATE YML ]`
- [ ] Replace the following line
   ```
   [INSERT CONTENT FROM SHEET]
   ```
   with
   ```
   [INSERT CONTENT FROM SHEET]
   ```

**For PM, Merge Team, or Tech Lead**
- [ ] Once the pull request associated with this issue is approved and merged, please update and edit epic #4307 by
  - [ ] Checking off the dependency for this issue
  - [ ] If all dependencies are checked off, please move issue to the New Issue Approval column and remove the Dependency label

#### File and Code links you will need to work on this issue
- Directory to find the page in once you have it in your IDE: `.github/ISSUE_TEMPLATE/[ ISSUE TEMPLATE YML ]`
- This issue is part of epic #4307
@jdingeman jdingeman added Feature Missing This label means that the issue needs to be linked to a precise feature label. role missing size: missing epic Draft Issue is still in the process of being created labels Mar 29, 2023
@jdingeman jdingeman added this to New Issue Approval in Project Board via automation Mar 29, 2023
@github-actions

This comment was marked as outdated.

@jdingeman jdingeman self-assigned this Mar 29, 2023
@jdingeman jdingeman added Complexity: Large Feature: Onboarding/Contributing.md size: 5pt Can be done in 19-30 hours role: back end/devOps Tasks for back-end developers Collaborative Work role: dev leads Tasks for technical leads and/or merge team members ready for product Dependency An issue is blocking the completion or starting of another issue and removed Complexity: Missing Feature Missing This label means that the issue needs to be linked to a precise feature label. size: missing labels Mar 29, 2023
@jdingeman

This comment was marked as outdated.

@jdingeman jdingeman removed the Draft Issue is still in the process of being created label Mar 29, 2023
@ExperimentsInHonesty

This comment was marked as outdated.

@ExperimentsInHonesty

This comment was marked as outdated.

@ExperimentsInHonesty

This comment was marked as outdated.

@ExperimentsInHonesty

This comment was marked as resolved.

@ExperimentsInHonesty

This comment was marked as outdated.

@Ris345
Copy link
Member

Ris345 commented Aug 9, 2023

Instructions for testing updated issue templates:

  • Push your issue branch to your fork of the website repository, as described in Section 3.1.a of CONTRIBUTING doc, for example: git push --set-upstream origin test-update-labels-1234
  • The response from the push command will include the URL for creating a pull request. Copy/Paste the URL below for use after testing:
    REPLACE THIS TEXT WITH URL FOR CREATING PR
  • Browse to your fork of the website repository and click Settings
Screenshot of Repository Settings

image

  • Change the default branch to the new issue branch
Screenshot of Default Branch Setting

image

  • Further down on the settings page under Features, check the Issues checkbox
Screenshot of Issues Checkbox

image

  • Browse to the Issues page, then click Labels
Screenshot - creating labels in the test Repo

image

  • Create labels corresponding to each label that was listed in the updated issue template. The color of the labels don't have to match those on the hackforla/website repository, but the text of the labels must match exactly.
  • From the Issues page, click New Issue then locate the template updated by your issue, and click Get Started to open the issue template.
  • Copy/Paste the URL of the issue template into the Resources section of the issue, replacing the text: REPLACE THIS TEXT WITH URL OF THE ISSUE TEMPLATE ON THE TEST REPO
    This will enable others to check the template.
  • Verify the appearance of the issue template, including careful examination of the labels. If there is a discrepancy between the labels listed in the issue and the labels that appear on the issue template, ask a dev lead or merge team member for help.
  • Complete the PR process by visiting the URL saved from the push command
  • Copy these sections from the Issue into the PR
    • "For PR Reviewers and Merge Team"
    • "Link for Reviewers"
    • "For PM, Merge Team, or Tech Lead"

@ExperimentsInHonesty ExperimentsInHonesty removed ready for dev lead Issues that tech leads or merge team members need to follow up on Dependency An issue is blocking the completion or starting of another issue labels Sep 24, 2023
@ExperimentsInHonesty ExperimentsInHonesty moved this from Ice box to Prioritized backlog in Project Board Sep 24, 2023
@JessicaLucindaCheng JessicaLucindaCheng moved this from Prioritized backlog to In progress (actively working) in Project Board Oct 16, 2023
@JessicaLucindaCheng
Copy link
Member

Closing issue as per instructions in the last Action Item

Project Board automation moved this from In progress (actively working) to QA Oct 16, 2023
@HackforLABot HackforLABot moved this from QA to Done in Project Board Oct 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Large epic Feature: Board/GitHub Maintenance Project board maintenance that we have to do repeatedly Feature: Onboarding/Contributing.md Issue Making: Level 4 Create an Epic Issue, and it's Level 2 or 3 issues role: back end/devOps Tasks for back-end developers role: dev leads Tasks for technical leads and/or merge team members size: 2pt Can be done in 7-12 hours
Projects
Project Board
  
Done
Development

No branches or pull requests

5 participants