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

• Familiarize yourself with our existing GitHub Actions
  • Identify if any of them should be temporarily edited to include messages to developers about the new implementation
    • Add list to a comment, with general instructions on what might be included per GHA
    • Add any additional GHAs you think we could write that would post something on an issue or PR that would be helpful.
• 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

• A GitHub Action that leaves a comment when developers assign themselves to issues
  • The message serves as a reminder that we are implementing a new VS Code extension
  • 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
• A GitHub Action that leaves a comment on new prework issues
  • The message serves as a reminder for the new dev that we are implementing a new VS Code extension
  • 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
• A GitHub Action that leaves a comment on newly created pull requests
  • 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 Create a Roll Out Plan for adding Code Spell Checker VS Code Extension #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

[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

[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

[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.

[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

[HackforLABot]

Hi @karengcecena, HfLA appreciates your interest in this issue, but please note that it is in the "New Issue Approval" column of the Project Board because it has not been finalized, approved, or prioritized, and so it is not ready for assignment. For this reason, you have been unassigned from this issue. Please remember to assign issues only from the "Prioritized Backlog" column.

The only exceptions to this rule are if you are writing an issue and the Draft label is applied, or if you are self-assigning to your "Pre-work Checklist" (the issue includes the Complexity: Prework label).

[ExperimentsInHonesty]

The roll-out has happened, and the messaging was not rolled out in time but the ER that was made from this was really valuable and this issue will serve as guidance on how to roll out another linter.