hackforla / hackforla/tdm-calculator

Dev: Create GHA to post a comment on PRs with spelling errors

Open
#2,403 0 comments 0 reactions 0 assignees View on GitHub
deck: staging feature: spelling level: medium Participant type: Admin Participant type: User priority: MUST HAVE role: back-end size: 1pt time sensitive
Dominant language
JavaScript
Stars
68
Forks
47
Avg merge
3d 9h
Merged PRs (30d)
25

Description

### Dependency
- #2402 - templates have been created, so that we can link it in the instructions of the post the GHA will make
- #3167
- #3169

### Overview
We need to create a GitHub Action (GHA) that posts a comment on the PRs when the linter throws an error

### Details
- The comment should have instructions for
- capturing and documenting the list of the "misspelled" words the linter finds
- checking epic for outstanding issues so you don't duplicate
- how to create a new issue, using the template `Dev: Update the spelling linter exclusion list with new terms`

### Action Items
- [ ] Write a draft of what the message would say
- [ ] Create a GHA that is triggered by a PR when the linter shows misspelled words

### Resources/Instructions

#### Slides
- [Staging Deck](https://docs.google.com/presentation/d/1crZ3IxqA4hAu3qzD7ns93Ieuqjwh6wyEtuX_46cP-fg)
- [Staging Deck, slide 2403](https://docs.google.com/presentation/d/1crZ3IxqA4hAu3qzD7ns93Ieuqjwh6wyEtuX_46cP-fg/edit?slide=id.g34debdf982f_2_17#slide=id.g34debdf982f_2_17)
- Release Deck
- [YYYY-MM-DD Release Deck, slide ISSUE NUMBER]

#### Writing GHAs
- Please see these guidelines/helpfiles and instructions the website team has written about writing GHAs https://github.com/hackforla/website/wiki/Hack-for-LA's-GitHub-Actions

Contributor guide

Open the contributing guide

Research direction

Start by reading the GitHub Actions guidance in the linked website wiki and reviewing dependencies #2402, #3167, and #3169. Draft the comment instructions, then identify the repository's spelling-linter workflow and its error output. Done means a pull-request-triggered action posts the agreed comment when misspelled words are reported.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.