VS Code Spell Checker Extension: GHA Messaging

[jdingeman]

Overview

As a part of the roll out plan to implement the VS Code Spell Checker Extension across the website team, we need to provide developers with message notifications about the new extension so that we ensure a smooth transition to its use.

Action Items

• [x] Familiarize yourself with our existing GitHub Actions
  • [x] Identify if any of them should be temporarily edited to include messages to developers about the new implementation
    • [x] Add list to a comment, with general instructions on what might be included per GHA
    • [x] Add any additional GHAs you think we could write that would post something on an issue or PR that would be helpful.
• [x] Present your documentation (a comment with the details of where and what) to the Product and Dev Lead team and refine plan as needed
• [ ] Create issues to make the changes (one per GHA).
  • [ ] Add this issue as a Dependency to the new issues

Potential Scenarios

• [x] A GitHub Action that leaves a comment when developers assign themselves to issues
  • [x] The message serves as a reminder that we are implementing a new VS Code extension
  • [x] The message should include a checkbox for the dev to acknowledge that they've read and understand the instructions and changes to the contributing.md
• [x] A GitHub Action that leaves a comment on new prework issues
  • [x] The message serves as a reminder for the new dev that we are implementing a new VS Code extension
  • [x] The message should include a checkbox for the dev to acknowledge that they've read and understand the instructions and changes to the contributing.md
  • [x] A GitHub Action that leaves a comment on newly created pull requests
  • [x] This message will notify pull request reviewers that any changes in a developer's pull request (specifically spelling corrections) will be considered within the scope of their issue, since they can make the changes in a file containing spelling errors
  • e.g.

    We added a spelling linter on X date, If the PR contains spelling changes, those are included in the scope of this issue. if the PR has not passed the linter because spelling changes are suggested, please see the contributing X section for installing the VS code plugin.

For PM, Tech Lead, Merge Team

• [ ] When the GHA Messaging plan is accepted, review the changes and determine how they will be implemented (feature branch, etc.)
• [ ] Release dependency on #4349. If all dependencies have been satisfied, move that issue into the New Issue Approval column with the ready for dev lead or ready for product label for review and a note about where to find the finished plan.

Resources

• HackforLA's GitHub Actions Guide
• HackforLA's GitHub Actions

[github-actions[bot]]

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

[karengcecena]

i. Availability: From 7:30am - 2:30pm on April 18-21 & April 24-25 ii. ETA: April 25 EOD

[karengcecena]

GHA MESSAGING:

Good afternoon,

Below I listed some ideas on which GHA should be edited to include messages to developers about the new VS Code Extension implementation. I also wanted to note that the current Hack for LA's Current GHA's Documentation is missing a lot of the GHAs currently found in the website repository. I searched through the website repository itself to find the GHAs that needed the updates on the extension.

1. AFTER NEW ISSUE ASSIGNMENT:

• Within github-actions/trigger-issue/add-preliminary-comment
• Edit the current preliminary comment to add a checkbox that links to how you would add the extension:
  • "As a part of the roll out plan to implement the VS Code Spell Checker Extension across the website team, please make sure that your VS Code is up to date with this extension so that we ensure a smooth transition to its use. See [INSTRUCTIONS LINK IN CONTRIBUTING.md]"
  • [ ] "Please check this box to acknowledge you have downloaded and installed the VS Code Spell Checker Extension"

2. AFTER NEW PR IN PR INSTRUCTIONS:

• Within github-actions/pr-instructions
• Edit the current new pr instructions layout to add a checkbox that links to how you would add the extension
  • "As a part of the roll out plan to implement the VS Code Spell Checker Extension across the website team, please make sure that your VS Code is up to date with this extension so that we ensure a smooth transition to its use. See [INSTRUCTIONS LINK IN CONTRIBUTING.md]"
  • [ ] "Please check this box to acknowledge you have downloaded and installed the VS Code Spell Checker Extension"
  • ALSO:
    • Notify that “any changes in a developer's pull request (specifically spelling corrections) will be considered within the scope of their issue, since they can make the changes in a file containing spelling errors”
      • ex: “We added a spelling linter on X date,
        • If the PR contains spelling changes, those are included in the scope of this issue.
        • if the PR has not passed the linter because spelling changes are suggested, please see the contributing X section for installing the VS code plugin.”

3. IN NEW PRE-WORKS:

• Edit the current pre-work checklist layout to add a checkbox that links to how you would add the extension:
  • "As a part of the roll out plan to implement the VS Code Spell Checker Extension across the website team, please make sure that your VS Code is up to date with this extension so that we ensure a smooth transition to its use. See [INSTRUCTIONS LINK IN CONTRIBUTING.md]"
  • [ ] "Please check this box to acknowledge you have downloaded and installed the VS Code Spell Checker Extension"

4. IN OLD PRE-WORKS:

• Maybe old pre-work checklists can be re-opened with an update needed tag and have this be posted as a new comment:
  • "As a part of the roll out plan to implement the VS Code Spell Checker Extension across the website team, please make sure that your VS Code is up to date with this extension so that we ensure a smooth transition to its use. See [INSTRUCTIONS LINK IN CONTRIBUTING.md]"
  • [ ] "Please check this box to acknowledge you have downloaded and installed the VS Code Spell Checker Extension"
• Then when devs acknowledge it, they can remove the updated needed tag

[karengcecena]

PROGRESS UPDATE:

1. Progress:

   • Completed:
   • Familiarized myself with GHAs Guide
   • Familiarized myself with HfLA's GHAs
   • Created the above list with ideas on which GHAs can be edited to include VS Code Extension Implementation Reminders
   • Left to do:
   • I need the Product and Dev Lead team to refine plan as needed so I can move on to create issues to make the changes

2. Blockers: None

3. Availability: From 7:30am - 2:30pm on April 24-28

4. ETA: April 28 EOD

[jdingeman]

Hi @karengcecena - nice work! We are going to discuss this today during the Dev Lead/PM meeting.

[ExperimentsInHonesty]

@karengcecena please use the ER template to note this issue you raised

I also wanted to note that the current Hack for LA's Current GHA's Documentation is missing a lot of the GHAs currently found in the website repository.

In that ER if you can list all the GHAs, then we can look at that list there, to see if we agree with your assessment of which ones get the notice.

[ExperimentsInHonesty]

Notes:

1. AFTER NEW ISSUE ASSIGNMENT: Revise please. A link to the instructions is good, and then after provide a check box asking them to acknowledge that they have added the vs code extension

As a part of the roll out plan to implement the VS Code Spell Checker Extension across the website team, please make sure that your VS Code is up to date with this extension so that we ensure a smooth transition to its use.  See [INSTRUCTIONS LINK IN CONTRIBUTING.md]"
- [ ] Please check this box to acknowledge you have downloaded and installed the VS Code Spell Checker Extension

[ExperimentsInHonesty]

@hackforla/website-merge is going to take a look at all the messages to see if they make sense before I look at them again. Remember to use as few words as possible to get the point across.

[roslynwythe]

Hi @karengcecena I'm moving this issue back to In Progress. Please revise your suggested GHA messaging to be more in line with Bonnie's https://github.com/hackforla/website/issues/4469#issuecomment-1558260181. The text in the Action Items of this issue was quite wordy, so Bonnie suggested more concise wording and also the inclusion of a link to the instructions in CONTRIBUTING.md.

[github-actions[bot]]

@karengcecena

Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' 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. 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 30, 2023 at 12:15 AM PST.}

[karengcecena]

Progress: This PR was recently viewed by Bonnie and suggestions were made. I need to go back and incorporate those suggestions. Blockers: None as of now, just time Availability: Monday 9am - 12 pm ETA: I plan for the suggestions to be incorporated by Monday. Pictures (optional): N/A

[karengcecena]

Progress: None since last update Blockers: I am extremely sick right now, so I've been resting Availability: Monday 9am - 12 pm ETA: I plan for the suggestions to be incorporated by Monday. Pictures (optional): N/A

[github-actions[bot]]

@karengcecena

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. 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, June 13, 2023 at 12:16 AM PST.}

[karengcecena]

Progress: I have implemented @ExperimentsInHonesty 's and @roslynwythe 's comments to revise the wording of my GHA suggestions. Blockers: I do not have a link to the contributing.md section (I don't think it exists yet?). Availability: Monday-Tuesday, June 19-20, 2023, 9am-5pm. ETA: 2 weeks from now (~ June 30th, 2023)

[ExperimentsInHonesty]

@karengcecena I created this using the Chat GPT prompt after I removed the mention of the roll out plan and I added back in the link to contrib and the requirement for PR.

• [ ] Check this box if you have updated and installed the VS Code Spell Checker Extension. See [INSTRUCTIONS LINK IN CONTRIBUTING.md]. Required on all issues that will result in PRs

Here is our convo

User please reword this to be a single check box instruction be susccinct to implement the VS Code Spell Checker Extension , please make sure that your VS Code is up to date with this extension . See [INSTRUCTIONS LINK IN CONTRIBUTING.md]" "Please check this box to acknowledge you have downloaded and installed the VS Code Spell Checker Extension"

ChatGPT "Check this box if you have updated and installed the VS Code Spell Checker Extension."

Are you able to come to a meeting so we can work on this together?

[github-actions[bot]]

@karengcecena

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. 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, June 27, 2023 at 12:17 AM PST.}

[karengcecena]

Hi @ExperimentsInHonesty. Sorry I missed your comment, I didn't receive a notification for it. I can try to make it to the meeting on Sunday to talk about it.

[github-actions[bot]]

@karengcecena

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. 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, July 11, 2023 at 12:18 AM PST.}

[github-actions[bot]]

@karengcecena

Please add update using the below template (even if you have a pull request). Afterwards, remove the '2 weeks inactive' 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 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, July 18, 2023 at 12:16 AM PST.}

[karengcecena]

I will be unassigning myself from this issue because I am struggling to make the time to make a dev meeting.

Progress: None Blockers: Time Availability: N/A ETA: N/A

[roslynwythe]

• Thank you @karengcecena for creating #4728 which provides a list of all our GHAs so we can be sure that our messaging includes all relevant GHAs, and we can create issues to fill in the missing documentation.

[github-actions[bot]]

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

[yujioshiro]

• Availability: Thursday 12pm-3pm, Saturday 4pm-6pm
• ETA: currently speaking with Roslyn and reading through the history to get up to speed on this issue. Will update ETA as time progresses

[yujioshiro]

Spoke with Roslyn. It seems there are issues that this issue depends on that will take some time to finalize. I will be unassigning myself from this issue in order to work on another issue.

[github-actions[bot]]

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

[t-will-gillis]

Hi @Jung-GunSong - Did you close this issue intentionally?

[Jung-GunSong]

Hi @t-will-gillis I thought I had just looked at it, but I guess I closed it by accident. I've re-opened it. My apologies.

[t-will-gillis]

@Jung-GunSong No problem! Thanks for reopening it