Skip to content

[Due for payment 2025-05-30] [$250] Investigate spell checking action for App codebase #54810

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mountiny opened this issue Jan 6, 2025 · 57 comments
Assignees
Labels
Awaiting Payment Auto-added when associated PR is deployed to production External Added to denote the issue can be worked on by a contributor NewFeature Something to build that is a new item. Reviewing Has a PR in review Weekly KSv2

Comments

@mountiny
Copy link
Contributor

mountiny commented Jan 6, 2025

Coming from here

Problem

We have typos/misspells across the codebase. For example, I saw following typos in a single file: TASK_TITLE_WITH_OPTONAL_SHORT_MENTION, reportRecipientAcountIDs, incoke

Background

We accept many contributions from all over the world, and sometimes, it can be difficult to spot such typos during code review. This is especially true when PRs need to be merged urgently to fix important bugs or if PRs are big enough (we can't simply go through each letter in changes to assure that the codebase doesn't have typos).

Solution

We can enable tools for spell checking. The most know one is cspell . We can integrate it as a part of our eslint pipeline (https://www.npmjs.com/package/@cspell/eslint-plugin) or we can integrate it via GitHub actions as a standalone check using https://github.com/streetsidesoftware/cspell-action.

Lets investigate how long would such action run if we run it on each commit on PRs only on the files that changed.

Upwork Automation - Do Not Edit
  • Upwork Job URL: https://www.upwork.com/jobs/~021876644443513097620
  • Upwork Job ID: 1876644443513097620
  • Last Price Increase: 2025-01-07
  • Automatic offers:
    • dominictb | Contributor | 106642648
Issue OwnerCurrent Issue Owner: @alexpensify
@mountiny mountiny added Daily KSv2 NewFeature Something to build that is a new item. AutoAssignerNewDotQuality Used to assign quality issues to engineers labels Jan 6, 2025
@mountiny mountiny self-assigned this Jan 6, 2025
Copy link

melvin-bot bot commented Jan 6, 2025

Current assignee @mountiny is eligible for the AutoAssignerNewDotQuality assigner, not assigning anyone new.

Copy link

melvin-bot bot commented Jan 6, 2025

Triggered auto assignment to @alexpensify (NewFeature), see https://stackoverflowteams.com/c/expensify/questions/14418#:~:text=BugZero%20process%20steps%20for%20feature%20requests for more details. Please add this Feature request to a GH project, as outlined in the SO.

@melvin-bot melvin-bot bot added Weekly KSv2 and removed Daily KSv2 labels Jan 6, 2025
@kirillzyusko
Copy link
Contributor

Hi, I'm Kiryl from Margelo expert agency and I'd like to work on this issue 🙌

@parasharrajat
Copy link
Member

parasharrajat commented Jan 7, 2025

I would like to be C+ reviewer of this if needed. @mountiny

@parasharrajat
Copy link
Member

I think we can add this as git Hook to check spellings. That should save us action hours and time.

@kirillzyusko
Copy link
Contributor

git Hook to check spellings

Git hooks can be easily bypassed locally (with --no-verify flag). We should integrate it to CI process in my opinion (eslint or separate job)

@parasharrajat
Copy link
Member

Aha, yeah. Maybe server-side hooks. But the ESlint check looks good too if it does not take more time. We can add an ESLint parallel job.

@mountiny mountiny added the External Added to denote the issue can be worked on by a contributor label Jan 7, 2025
@melvin-bot melvin-bot bot changed the title Investigate spell checking action for App codebase [$250] Investigate spell checking action for App codebase Jan 7, 2025
Copy link

melvin-bot bot commented Jan 7, 2025

Job added to Upwork: https://www.upwork.com/jobs/~021876644443513097620

@melvin-bot melvin-bot bot added the Help Wanted Apply this label when an issue is open to proposals by contributors label Jan 7, 2025
Copy link

melvin-bot bot commented Jan 7, 2025

Triggered auto assignment to Contributor-plus team member for initial proposal review - @ishpaul777 (External)

@melvin-bot melvin-bot bot added Daily KSv2 and removed Weekly KSv2 labels Jan 7, 2025
@mountiny
Copy link
Contributor Author

mountiny commented Jan 7, 2025

@parasharrajat thanks! But I think we can follow the process here as its not part of any project where you have worked before. Dont want to set a precedence where C+ comment on new issues

@mountiny mountiny removed the Help Wanted Apply this label when an issue is open to proposals by contributors label Jan 7, 2025
@shubham1206agra
Copy link
Contributor

@parasharrajat thanks! But I think we can follow the process here as its not part of any project where you have worked before. Dont want to set a precedence where C+ comment on new issues

@mountiny I am afraid, but that ship sailed a long time ago. Not going to name anyone here.

@mountiny
Copy link
Contributor Author

mountiny commented Jan 7, 2025

Does not matter, lets just not make it a norm

@parasharrajat
Copy link
Member

Works for me. I just noticed this happening and wasn't getting any work so I followed one or two.

After a discussion internally, I can say this should not be followed on for post-initial project issues. After the main implementation for a project is done. The follow-up should be auto assigned unless planning beforehand.

@melvin-bot melvin-bot bot added Weekly KSv2 Awaiting Payment Auto-added when associated PR is deployed to production and removed Weekly KSv2 labels May 21, 2025
@melvin-bot melvin-bot bot changed the title [$250] Investigate spell checking action for App codebase [Due for payment 2025-05-28] [$250] Investigate spell checking action for App codebase May 21, 2025
Copy link

melvin-bot bot commented May 21, 2025

Reviewing label has been removed, please complete the "BugZero Checklist".

@melvin-bot melvin-bot bot removed the Reviewing Has a PR in review label May 21, 2025
Copy link

melvin-bot bot commented May 21, 2025

The solution for this issue has been 🚀 deployed to production 🚀 in version 9.1.47-6 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

If no regressions arise, payment will be issued on 2025-05-28. 🎊

For reference, here are some details about the assignees on this issue:

Copy link

melvin-bot bot commented May 21, 2025

BugZero Checklist: The PR adding this new feature has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

  • [@ishpaul777 / @dominictb] Please propose regression test steps to ensure the new feature will work correctly on production in further releases.
  • [@alexpensify] Link the GH issue for creating/updating the regression test once above steps have been agreed upon.

@melvin-bot melvin-bot bot added Reviewing Has a PR in review Weekly KSv2 and removed Weekly KSv2 labels May 21, 2025
@dominictb
Copy link
Contributor

dominictb commented May 21, 2025

Not due for payment yet. But we're almost there!!!

@alexpensify alexpensify changed the title [Due for payment 2025-05-28] [$250] Investigate spell checking action for App codebase [$250] Investigate spell checking action for App codebase May 21, 2025
@alexpensify alexpensify removed the Awaiting Payment Auto-added when associated PR is deployed to production label May 21, 2025
@melvin-bot melvin-bot bot added Weekly KSv2 Awaiting Payment Auto-added when associated PR is deployed to production and removed Weekly KSv2 labels May 22, 2025
@melvin-bot melvin-bot bot changed the title [$250] Investigate spell checking action for App codebase [Due for payment 2025-05-30] [$250] Investigate spell checking action for App codebase May 23, 2025
@melvin-bot melvin-bot bot removed the Reviewing Has a PR in review label May 23, 2025
Copy link

melvin-bot bot commented May 23, 2025

Reviewing label has been removed, please complete the "BugZero Checklist".

Copy link

melvin-bot bot commented May 23, 2025

The solution for this issue has been 🚀 deployed to production 🚀 in version 9.1.50-0 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

If no regressions arise, payment will be issued on 2025-05-30. 🎊

For reference, here are some details about the assignees on this issue:

Copy link

melvin-bot bot commented May 23, 2025

BugZero Checklist: The PR adding this new feature has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

  • [@ishpaul777 / @dominictb] Please propose regression test steps to ensure the new feature will work correctly on production in further releases.
  • [@alexpensify] Link the GH issue for creating/updating the regression test once above steps have been agreed upon.

@melvin-bot melvin-bot bot added Reviewing Has a PR in review Weekly KSv2 and removed Weekly KSv2 labels May 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Awaiting Payment Auto-added when associated PR is deployed to production External Added to denote the issue can be worked on by a contributor NewFeature Something to build that is a new item. Reviewing Has a PR in review Weekly KSv2
Projects
Status: LOW
Development

No branches or pull requests

9 participants