website
website copied to clipboard
ER: Changes Needed for add-github-handle issue template and Epic instruction comments
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
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:
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
@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).
@tony1ee That makes sense. I've made those changes.
@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.
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 :)
Can I remain assigned as I am interested in writing this issue when it's approved to move forward?
example of code url https://github.com/hackforla/website/blob/gh-pages/_projects/100-automations.md?plain=1
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
@tony1ee this looks good. I made the change you suggested to this comment of #5441
I have added this to the dev/pm agenda for a little cleanup before we prioritize
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 :)
@roslynwythe will help @tony1ee re write the proposed issue
@roslynwythe Please review the revised ER.
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 :)
i. Availability: SAT 05/11/2024 ii. ETA: EOD 05/11/2024
@tony1ee
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.
- Progress: "What is the current status of your project? What have you completed and what is left to do?"
- Blockers: "Difficulties or errors encountered."
- Availability: "How much time will you have this week to work on this issue?"
- ETA: "When do you expect this issue to be completed?"
- 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 Questions/In Review
column of the Project Board 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. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.
You are receiving this comment because your last comment was before Tuesday, May 21, 2024 at 12:06 AM PST.
Blockers: waiting for prioritization