Skip to content
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

Adds pre-commit linters #1672

Merged
merged 3 commits into from
Aug 28, 2023
Merged

Adds pre-commit linters #1672

merged 3 commits into from
Aug 28, 2023

Conversation

ElPaisano
Copy link
Contributor

@ElPaisano ElPaisano commented Aug 18, 2023

Describe your changes

This PR adds a script (and its associated packages, configs, etc.) that runs automatically on local git commit and checks for:

  • Invalid/ dead Markdown links
  • Bad Markdown formatting
  • Spelling errors
  • Writing style

What issue(s) does this address?

  • Set writing standards
  • Minimize number of edits needed to be made to a PR
  • Provide self service tools for contributors
  • Scale editing process

How to test

  1. Pull down this branch.
  2. Make a change to a markdown file. Ideally, make an intentional error so that the full script is triggered.
  3. git add the file
  4. git commit -m -> This should trigger the script
  5. Repeat steps 2-4 until the pre-commit check passes.

@ElPaisano ElPaisano marked this pull request as draft August 18, 2023 01:26
@ElPaisano ElPaisano changed the base branch from main to editing August 28, 2023 17:10
@ElPaisano ElPaisano marked this pull request as ready for review August 28, 2023 20:12
@ElPaisano ElPaisano merged commit 79773c9 into editing Aug 28, 2023
3 checks passed
@ElPaisano ElPaisano deleted the add/precommit branch August 28, 2023 20:12
@ElPaisano ElPaisano mentioned this pull request Aug 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant