Create a Roll Out Plan for adding Code Spell Checker VS Code Extension

[jdingeman]

Dependency

• VS Code Spell Checker Extension: GHA Messaging #4469
• VS Code Spell Checker Extension: Meeting Messaging #4470
• Decision Record: VS Code Spell Checker Extension #4471
• Epic: Create template, spreadsheet and list of issues for spellcheck audit #5248
• Epic: Create issues to add false positives to cspell.json #5312
• Create initial spell check configuration file #5313
• Epic: Create issues to add ignorePaths to cSpell configuration file #5450
• add instructions for workstation spell checking using npm package #5652
• Create issue template "Resolve Spell Check warning" #6446

Overview

We need to create a roll out plan for having all HfLA website developers install the Code Spell Checker VS Code extension so that we can reduce confusion for our dev team when using in their local development environment, during PRs, and while reviewing PRs.

Action Items

• Draft a Plan Overview
• Decide if feature branches are necessary
• Review with Merge Team
• Create issues for each of the items that need it
  • Add them to the Dependencies section of this issue
• Once all components (dependency issues) of the plan are drafted (not yet completed)
  • Identify what can be done now, and what has to wait until a specific trigger
  • TBD...

Resources/Instructions

• Add Code Spell Checker VS Code extension installation instructions #4101
• Decision Records
• Code Spell Checker

[jdingeman]

@ExperimentsInHonesty - I know the Wiki is on a pause right now but my thought was that the Wiki would likely be migrated to Mkdocs before this gets implemented, but please let me know if we should go with an alternative, like Google Docs.

[ExperimentsInHonesty]

Plan Overview

Instructions

Requirements

• Clear wording
• Links to relevant files
• Screenshots when required

What to cover

• How to install locally
• How to increase the scope of your issue if the local linter finds problems (what to note in the issue and pr)
• What do we expect will happen when you do a PR and what to do about it
  • if you don't catch all the problems, the linter will find locally
  • if you do catch all the problems, the linter will find locally
  • if the repo linter finds other problems the local linter did not (we hope it won't but...)
• PR reviewers: How to handle scope changes, caused by the local linter, in the PR you are reviewing

Where to message

Contributing.md

Wiki

• DR
• Other?

Prework template

• for new preworks

Slack

• Which channels

GHAs

• GHA messages on PRs
• GHA messages on existing issues
  • size of issue:
    • prework
    • ?

In Meetings

• HfLA onboarding
• Dev meetings (Tues, Thurs, Sun)

Actions & Timelines

You don't have to answer When? until all the messages are ready

Publish Instructions

Where

• Contributing file Add Code Spell Checker VS Code extension installation instructions #4101
• GHAs
• Slides

When?

Direct Developers to install the VS Code plugin during dev environment setup

Who:

• Existing developers
• New developers

When?

Install Linter on GitHub repo

When?

[ExperimentsInHonesty]

Draft ISSUE

Title: Spell Linter: GHA Messaging

Overview

Review the GHAs, identify what messaging will support the rollout plan, and draft messages.

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 and 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

• WIKI page with GHAs

[ExperimentsInHonesty]

Draft ISSUE

Title: Spell Linter: Meeting Messaging

Overview

Review the slides or instructions used during meetings, if any, and create additions or new materials to share the messaging that will support the rollout plan.

Action Items

• [@jdingeman ADD SOME STEPS HERE]

Resources

• [ADD LEAD RESOURCES??]
• HfLA website onboarding slide
• Code Spell Checker as a local linter

[ExperimentsInHonesty]

Draft ISSUE

Title: DR: Spelling Linter

Overview

We need to create a Decision Record so that we have the history of why & how we are using this spelling linter so that people in the future can understand it.

Action Items

• Create a DR Solutions Adopted wiki page
  • why we are using a linter
  • why this one (what were the requirements)
  • links
  • link to plan Issue Create a Roll Out Plan for adding Code Spell Checker VS Code Extension #4349
  • etc.
• Add the wiki page to the Decision Records on Solutions Adopted

Resources

Decision Records on Solutions Adopted

• Code Spell Checker as a local linter

[ExperimentsInHonesty]

Draft ISSUE

Title: Spell Linter: Slack Messaging

Overview

Write the messaging that will go out in Slack channels and when (related to other messages) it should go out, so that we can make sure to catch people at every location they might need to receive these messages

Action Items

• Review the most recent Slack Audit Document
• Identify which channels we should message in
• Identify which methods you recommend employing
  • Pins
  • Bookmarks
  • Reminders
• Write up messaging in a comment (include which channel)

Resources

• HfLA website: Slack Audit
• Code Spell Checker as a local linter

HfLA website: Slack Channels

#hfla-site
#hfla-site-onboarding
#hfla-site-ux
#hfla-site-pr
#website-merge

[ExperimentsInHonesty]

JD's original draft

Overview

We need to create a roll out plan for having all HfLA website developers install the Code Spell Checker VS Code extension so that we can reduce confusion for our dev team when using in their local development environment, during PRs, and while reviewing PRs.

Action Items

• Develop a plan of action for the implementation of Code Spell Checker as a local linter
• Familiarize yourself with our existing GitHub Actions and if any of them can be temporarily edited to include messages to developers about the new implementation
• The plan should include the following:
  • How we will make sure all new and active developers know to install the extension
  • 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.

  • Updating the contributing.md with issue Add Code Spell Checker VS Code extension installation instructions #4101
  • Notifications during meetings, onboarding, etc.
  • You will want the plan to cover all corners and cases so that no one misses out on this new implementation
• Create a Wiki in Decision Records on Solutions Adopted with this details plan
  • Be sure to include proposed wording of Slack messages, wording of GHA messages, timelines for each step, potential issues to create, etc.
  • Add a link to this new article to the main Decision Records page
• Present your documentation to the Product and Dev Lead team and refine plan as needed

For PM, Tech Lead, Merge Team

• When the roll out plan is accepted, release dependency on Add Code Spell Checker VS Code extension installation instructions #4101 and move that issue into the New Issue Approval column with the ready for dev lead or ready for product label for review

Resources/Instructions

• Add Code Spell Checker VS Code extension installation instructions #4101
• Decision Records
• Code Spell Checker

[ExperimentsInHonesty]

@jdingeman I have revised the top part of this issue. I am going to bring it to the Dev Lead/PM meeting today so that we can discuss the plan with the merge team.

[ExperimentsInHonesty]

@jdingeman We discussed and made some changes. So I have put a role: dev leads label on this and put it back into new issue approval, so you can add any notes from the Monday meeting to it. Then, maybe it goes into the prioritized backlog without you being assigned to it, and we look at the rest of your assigned issues and do a little overall reprioritizing

[github-actions]

@roslynwythe

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, June 18, 2024 at 12:06 AM PST.}

[github-actions]

@roslynwythe

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 Wednesday, June 19, 2024 at 1:48 PM PST.}