ER: Changes Needed for add-github-handle issue template and Epic instruction comments

tony1ee commented 3 weeks ago

Emergent Requirement - Problem

we have decided to change the QA validation link in the add-github-handle issue template so it defaults to code instead of preview.

Details

Line planned to update in issue template

https://github.com/hackforla/website/blob/caa4f1bc759cfbad28eab8f47dc2ffd0badf17c0/.github/ISSUE_TEMPLATE/add-github-handle.md?plain=1#L38

we want to change it to

For QA to validate change: https:\//github.com/hackforla/website/blob/gh-pages/_projects/[INSERT_PROJECT_FILE]?plain=1

Issue you discovered this emergent requirement in

6695

Date discovered

04/25/2024

Did you have to do something temporarily

[x] YES
[ ] NO

Who was involved

@tony1ee @roslynwythe

What happens if this is not addressed

If we don't make these changes, future issue makers for add-github-handle issues would create new issues that have irrelevant resource link and receive inaccurate instruction on how to populate placeholder in that link.

Resources

Epic for creating issues #5441
add-github-handle issue template .github/ISSUE_TEMPLATE/add-github-handle.md
testing instructions for issue templates

Recommended Action Items

[x] Make a new issue
[ ] Discuss with team
[ ] Let a Team Lead know

Potential solutions [draft]

Creat an issue to change add-github-handle issue template .github/ISSUE_TEMPLATE/add-github-handle.md. Replace:

For QA to validate change: https://github.com/hackforla/website/blob/gh-pages/[INSERT-PATH-TO-PROJECT-FILE]

with:

For QA to validate change: https://github.com/hackforla/website/blob/gh-pages/_projects/[INSERT_PROJECT_FILE]?plain=1

github-actions[bot] commented 3 weeks ago

Hi @tony1ee.

Please don't forget to add the proper labels to this issue. Currently, the labels for the following are missing:

Complexity

NOTE: Please ignore this comment if you do not have 'write' access to this directory.

To add a label, take a look at Github's documentation here.

Also, don't forget to remove the "missing labels" afterwards. To remove a label, the process is similar to adding a label, but you select a currently added label to remove it.

After the proper labels are added, the merge team will review the issue and add a "Ready for Prioritization" label once it is ready for prioritization.

Additional Resources:

roslynwythe commented 2 weeks ago

Thank you @tony1ee for picking up on this problem and creating this detailed ER. Under "Proposed Solutions", I agree with items 2 - 4 and I completed those changes, so you can remove those items from the Proposed Solutions.

Regarding the issue I just wanted to suggest that the issue include these testing instructions for issue templates

tony1ee commented 2 weeks ago

@roslynwythe the idea of item 4 is to place a link in the main comment of #5441 pointing to the template modified in item 3.

I suggested this because the item-3 comment was a bit hard to find in the #5441 thread, and by linking to it therefore making it easier to find, we can reduce the chance of copying from previous Issue Making Issues (which could include inaccurate descriptions).

roslynwythe commented 2 weeks ago

@tony1ee That makes sense. I've made those changes.

tony1ee commented 2 weeks ago

@roslynwythe

I changed the main comment to hide the proposal 2-4.

I also added instructions to include testing instructions for issue templates when creating issue for proposal 1.

Please check if this ER is now ready to be moved forward.

github-actions[bot] commented 2 weeks ago

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

tony1ee commented 2 weeks ago

Can I remain assigned as I am interested in writing this issue when it's approved to move forward?

ExperimentsInHonesty commented 2 weeks ago

example of code url https://github.com/hackforla/website/blob/gh-pages/_projects/100-automations.md?plain=1

tony1ee commented 2 weeks ago

In dev lead meeting 04/29/2024 a decision has been made that we want to keep the QA link but change it slightly so it defaults to code instead of preview.

With this new direction, this issue and proposed solution has been updated.

@roslynwythe

roslynwythe commented 2 weeks ago

@tony1ee this looks good. I made the change you suggested to this comment of #5441

ExperimentsInHonesty commented 2 weeks ago

I have added this to the dev/pm agenda for a little cleanup before we prioritize

github-actions[bot] commented 1 week ago

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

ExperimentsInHonesty commented 1 week ago

@roslynwythe will help @tony1ee re write the proposed issue

tony1ee commented 1 week ago

@roslynwythe Please review the revised ER.

github-actions[bot] commented 1 week ago

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

tony1ee commented 1 week ago

i. Availability: SAT 05/11/2024 ii. ETA: EOD 05/11/2024

hackforla / website