RichardLitt / standard-readme-preset

remark preset to configure remark-lint with settings that enforce standard-readme.

ISC License

12 stars 8 forks source link

Add pre commit hook #40

Closed tpansino closed 3 years ago

tpansino commented 3 years ago

Pull Request

Description of Changes

Added a pre-commit hook for linting README.md files on-commit (via Git Hooks). Can also be used with this GitHub Action to enforce a passing check before merging. This also allows repo owners to define a single set of quality checks one time for both local development and the CI/CD pipeline.

tpansino commented 3 years ago

@RichardLitt, could you also start tagging releases after this is merged (assuming you agree to merge it 😅)? Pre-commit throws a warning unless you pin to a specific Git tag or SHA, and I see from the commit history that you're already versioning and bumping with each release.

RichardLitt commented 3 years ago

Want to be a maintainer? I don't use this module at the moment.

tpansino commented 3 years ago

Reopening as https://github.com/RichardLitt/standard-readme-cli/pull/6, because I didn't realize there was a CLI... :man_facepalming:

@RichardLitt, sure! Especially if that helps to get my changes merged :wink:.

Just so you know, I'm mostly a Python developer, and only have basic NodeJS skills, but I do work as a Senior DevOps engineer, so I'll pitch in where I can. :+1:

RichardLitt commented 3 years ago

Hmm. Seems that I spoke too soon - I was tired. Thanks for being willing.