Skip to content

Move npm-check commands from style-guide.md to pr-checks.md #7191

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
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

vitorvasc
Copy link
Member

Description

Closes #6601

As raised in #6601, it's not intuitive to have the npm checks commands listed on the Style guide page. We should probably move them to Pull request checks page or create a new one.

By taking a closer look at both pages, most of the commands described on the style-guide.md page are also on pr-checks.md:

Command in style-guide.md Present in pr-checks.md
npm run fix:all
npm run check:text
npm run check:text -- --fix
npm run check:markdown
npm run fix:markdown
npm run check:spelling
npm run fix:dict
npm run fix:format
npm run fix:filenames

Proposal

style-guide.md

  1. Remove the redundant commands from the Style guide page.
  2. Add a new section named Fixing validation issues, leading to the Pull request checks page.

pr-checks.md

Include the previously missing commands (npm run fix:markdown and npm run check:spelling).


The only command left in style-guide.md, at least for now, is npm run fix:format in the File format section. Does it make sense to keep it where we mention Prettier?

Signed-off-by: Vitor Vasconcellos <vitor.vasconcellos@mercadolivre.com>
@tiffany76
Copy link
Contributor

Thanks, @vitorvasc! I think @chalin will want to take a look at this PR when he's back online (mid-July), if you're okay waiting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

Move description of npm-check commands from the style guide into PR checks?
2 participants