website icon indicating copy to clipboard operation
website copied to clipboard

ER: The template for updating projects does not contain all the projects

Open ExperimentsInHonesty opened this issue 1 year ago • 2 comments

Emergent Requirement - Problem

The template for updating projects does not contain all the projects and I need to submit an update for Tech Work Experience

Issue you discovered this emergent requirement in

n/a

Date discovered

2024-05-20

Did you have to do something temporarily

  • [x] YES, make this issue to include the changes we will need for the twe card
  • [ ] NO

Who was involved

@ExperimentsInHonesty @joshfishman

What happens if this is not addressed

I can't submit an update for Tech Work Experience project

Resources

  • https://www.hackforla.org/projects/tech-work-experience
  • new issue template Project Profile Card review and update
  • https://github.com/hackforla/website/blob/gh-pages/.github/ISSUE_TEMPLATE/project-profile-card-review-and-update.yml

Recommended Action Items

  • [ ] Make a new issue
    • [ ] update existing template with new field under the Update GitHub Link section
      Do you have any additional (other than your primary) GitHub repositories that your volunteers make issues or PRs against?  
      YES/NO
      If yes, list the repo URLs here
      
    • [ ] have Bonnie test the template changes by using it to submit the following changes for TWE
      • add another repo to pull contributors from
  • [ ] Discuss with team
  • [ ] Let a Team Lead know

Potential solutions [draft]

ExperimentsInHonesty avatar May 20 '24 17:05 ExperimentsInHonesty

Hi @Zanderfeldt, 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 May 28 '24 20:05 github-actions[bot]

Hi @Zanderfeldt, I'm closing #6905 and unassigning you from this ER. This is an Emergent Request that requires an issue to be created, not an issue to resolve directly. It looks like it may have been placed in the "Prioritized backlog" column by mistake. Not your fault.

Upon reviewing your work, you've completed one good first issue and one Complexity: Small issue so far. Per the contributing guidelines, you should finish two good first issue tasks before tackling a Small issue.

Please complete one more good first issue before moving on to a Medium issue.

Thanks for your understanding!

jphamtv avatar Jun 06 '24 19:06 jphamtv

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

HackforLABot avatar Aug 26 '24 18:08 HackforLABot

Availability: Evenings after 5 pm ETA: 8/30 EOD

daras-cu avatar Aug 26 '24 18:08 daras-cu

I have created issue #7363 for this ER but had a few questions come up while working on it:

  • I added the same labels to the issue that are on this issue, minus the ER-specific ones. Is this correct?
  • More broadly I just want to confirm I understood the ER correctly. The problem it mentions is that Tech Work Experience is not included in the Project Card issue template, but the action items/the issue I wrote do not address that directly.

daras-cu avatar Aug 29 '24 02:08 daras-cu

Hi @daras-cu I checked out #7363 and have a couple of suggestions:

  • I was initially confused about placing the code snippet:

    Under the current lines

    attributes:
      label: GitHub Link  
    
  • It would be clearer, I believe, if you said something closer to what is in the description above, i.e. "Under the existing field that ends with the lines: "

  • Also, the code snippet for insertion has some indentation misalignment: in the first line, - type: dropdown needs to align with id

  • Part of me thinks we need to specify that the new section needs to match the formatting of the rest of the file (even though that should be a given). Your call.

  • For your second point, I think you are correct and that both the Project Name and the Project Card URL sections need the TWE even though it was not specified in the description.

    • You could add two more action items, one for inserting - Tech Work Experience alphabetically in the "Project Name" section and the other for inserting alphabetically - tech-work-experience.md in the "Project Card URL" section.
    • (Not your scope but it seems like the "Project Name" and "Project Card URL" sections could be combined. Also, I wonder if there are additional projects and project urls that are missing? Not your scope either.)
  • About the labels: This issue is more complex than a good first issue- I think it is at least a Complexity: Small, and at least size: 0.5pt (3 hours or less- do you agree?)

t-will-gillis avatar Aug 29 '24 03:08 t-will-gillis

Thanks so much @t-will-gillis, I made changes to the issue:

  • Added action items for TWE options in the Project Name and URL sections (I noticed the Project Name options at least are not fully alphabetical maybe due to project status, so I checked the order of projects on the website and specified to add it in the same place)
  • Added more specific description of where to add the code for the new GitHub field
  • Fixed the indentation in the code snippet
  • Added a note about matching the indentation pattern to the other fields
  • Changed size and complexity labels - this is actually why I wanted to double check on using the original labels, I agree it is more complex than a good first issue and 3 hrs or less seems reasonable

I also changed the title and overview slightly to reflect the TWE additions. Let me know if everything looks alright!

daras-cu avatar Aug 29 '24 04:08 daras-cu

Hey @daras-cu Thanks for making the changes- looks good!

I just thought of one more item- in the description of the issue created from an ER, I like to add a line similar to below in "Resources/Instructions":

- This issue initiated by ER #6863

t-will-gillis avatar Aug 29 '24 17:08 t-will-gillis

@t-will-gillis great, I added the line . Thanks for your help and suggestions!

daras-cu avatar Aug 30 '24 03:08 daras-cu

@daras-cu Great, I will close this issue as completed and add Ready for Prioritization on #7363 so that Bonnie can comment on it and let you know if anything else needs to be changed. Thanks for working on this!

Closing this as completed, see #7363

t-will-gillis avatar Aug 30 '24 03:08 t-will-gillis