website icon indicating copy to clipboard operation
website copied to clipboard

Audit for changing labels from size to complexity

Open SAUMILDHANKAR opened this issue 3 years ago • 12 comments

Overview

As a developer, I would like to track the size of an issue in terms of number of hours. In order to achieve that, we need to perform an audit to identify where size labels are currently being used in automations or other files before changing it to complexity.

Details

We are planning to edit the following labels:

  • Size: Good second issue to Complexity: Good second issue
  • Size: Small to Complexity: Small
  • Size: Medium to Complexity: Medium
  • Size: Large to Complexity: Large

However, before doing that we want to document all the automations that might be dependent on these existing labels, so that no workflows are affected by this change.

Action Items

  • [ ] Review all automations in GitHub Actions Workflow Directory and GitHub actions folder to figure out where size labels are being used
    • [ ] Once you have the updated code for the project in VS code, you can use the find function to search the above directories for the names of the existing labels (provided under Details above)
  • [ ] If there are more than 2 Create a spreadsheet (otherwise just list the info in the comments below) to list all the GitHub actions where size labels are being referenced
  • [ ] Document any other risks that might arise due to changing of labels
  • [ ] Suggest a timeline for changing the labels as well as a process to revert in case existing functionalities are impacted
  • [ ] For merge team: Once this issue is done and closed, please update and edit #3109 by
    • [ ] Checking off the dependency for this issue
    • [ ] Editing any action items if required
    • [ ] If all dependencies are checked off, please move issue #3109 to the New Issue Approval column, remove the Dependency label and add ready for milestone label.

Resources/Instructions

GitHub actions folder GitHub Actions Workflow Directory GHA architecture spreadsheet Events that trigger workflows Workflow syntax for GitHub Actions

SAUMILDHANKAR avatar Feb 13 '22 10:02 SAUMILDHANKAR

Hi @SAUMILDHANKAR.

Good job adding the required labels for this issue. The merge team will review the issue and add a "Ready for Milestone" label once it is ready for prioritization.

Additional Resources:

github-actions[bot] avatar Feb 13 '22 10:02 github-actions[bot]

Progress: just self-assigned Blockers: TBD Availability: 2 hrs for the rest of this week ETA: 06/15/2022

mmogri avatar Jun 01 '22 22:06 mmogri

@mmogri

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures: "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, June 7, 2022 at 12:21 AM PST.

github-actions[bot] avatar Jun 10 '22 07:06 github-actions[bot]

@mmogri

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures: "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, June 14, 2022 at 12:19 AM PST.

github-actions[bot] avatar Jun 17 '22 07:06 github-actions[bot]

Progress: minimal (work conference and family obligations past couple weeks) Blockers: TBD Availability: >10 hours ETA: 06/25/2022

mmogri avatar Jun 19 '22 15:06 mmogri

Progress: minimal (family obligations past couple weeks) Blockers: TBD Availability: >10 hours ETA: 07/02/2022

mmogri avatar Jun 29 '22 02:06 mmogri

@mmogri

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, July 5, 2022 at 12:19 AM PST.

github-actions[bot] avatar Jul 08 '22 07:07 github-actions[bot]

Progress: some Blockers: TBD Availability: >10 hours ETA: 07/15/2022

mmogri avatar Jul 10 '22 17:07 mmogri

@mmogri

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, July 19, 2022 at 12:21 AM PST.

github-actions[bot] avatar Jul 22 '22 07:07 github-actions[bot]

@mmogri

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, July 26, 2022 at 12:20 AM PST.

github-actions[bot] avatar Jul 29 '22 07:07 github-actions[bot]

@mmogri

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, August 2, 2022 at 12:20 AM PST.

github-actions[bot] avatar Aug 05 '22 07:08 github-actions[bot]

@mmogri

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, August 9, 2022 at 12:20 AM PST.

github-actions[bot] avatar Aug 12 '22 07:08 github-actions[bot]

@mmogri

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, August 16, 2022 at 12:21 AM PST.

github-actions[bot] avatar Aug 19 '22 07:08 github-actions[bot]

@mmogri

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, August 23, 2022 at 12:25 AM PST.

github-actions[bot] avatar Aug 26 '22 07:08 github-actions[bot]

@mmogri

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, August 30, 2022 at 12:27 AM PST.

github-actions[bot] avatar Sep 02 '22 07:09 github-actions[bot]

@mmogri

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, September 6, 2022 at 12:28 AM PST.

github-actions[bot] avatar Sep 09 '22 07:09 github-actions[bot]

@mmogri Hi, this issue has not been updated in over 2 weeks. If you are still interested in working with HfLA, please let us know by updating your ETA and Availability. If we don't hear back within 7 days, we will unassign you from this issue and put it back in the queue. Thanks!

kathrynsilvaconway avatar Sep 13 '22 02:09 kathrynsilvaconway

@mmogri

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, September 13, 2022 at 12:32 AM PST.

github-actions[bot] avatar Sep 16 '22 07:09 github-actions[bot]

This dev has left HfLA or has not responded to messages for 7 days. I'm returning this issue the the Prioritized Backlog.

kathrynsilvaconway avatar Sep 19 '22 02:09 kathrynsilvaconway

Hi @gstemmann, 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 :)

github-actions[bot] avatar Oct 19 '22 03:10 github-actions[bot]

Availability: 6 hours ETA: Oct 24, 2022

gstemmann avatar Oct 19 '22 03:10 gstemmann

Sizes are being referenced in 2 JS files (So, there is no spreadsheet required, according to the action items in the issue, and no changes have been made to the code.)

Both instances are in the Github Actions Folder.

  1. post-labels-comment.js --> contains many actions that utilize labels using the 'size' attribute one time in the declaration
  2. check-labels.js ---> also contains processes that utilize labels using the 'size' attribute one time in the declaration

Both Files use 'size', so this will need to be considered before changing the tags to 'Complexity:'

I will also note that the entire phrases,

  • Size: Good second issue to Complexity: Good second issue
  • Size: Small to Complexity: Small
  • Size: Medium to Complexity: Medium
  • Size: Large to Complexity: Large were not used throughout the 2 directories listed in the issue details above. Just the use of "Size:" and labels.

The suggested timeline for changing the labels as well as a process is still unclear due to multiple automations that may be involved outside of these 2 directories.

gstemmann avatar Oct 21 '22 04:10 gstemmann

Progress: The issue is being reviewed by the merge team to be ready to close, since this type of issue does not require a Pull Request. Blockers: N/A ETA: 10/30/2022

gstemmann avatar Oct 23 '22 19:10 gstemmann

Hey @gstemmann, Thank you for working on this issue and leaving notes.

Here are my notes to add for the next developer to work on #3109.

Currently, we have GHA that first checks for labels. If there's a missing Size series label, then it throws a size: missing label. It will post a comment as a reminder.

Suggestions & timeline for changes: Consider #3109 a large issue to make all the necessary changes at once instead of breaking them into small issues and making different changes at different times. While we make changes, we must document all the necessary changes to our wiki pages & contributing guide as well(if required). This will avoid any confusion for new devs. Please, merge everything with 1 PR only.

  • [ ] Replace the labels as per the details and action items
  • [x] update necessary changes to both files in the GitHub Action folder
  • [x] Test locally
  • [x] Check the contributing guide, update if necessary
  • [ ] Check the label missing, and size series and replace that too. resource
  • [ ] Bonus question: Discuss why we have the complexity: missing label with lead developers.
  • [ ] Double check if it affects any way to pre-work checklist templates in this folder
  • [ ] Make a plan and bring it as a demo of your research with the merge team before creating a PR

arpitapandya avatar Oct 28 '22 14:10 arpitapandya