From 612c4b4fda596d949d649461be139190a617bbc3 Mon Sep 17 00:00:00 2001 From: mauvehed Date: Sun, 30 Jul 2023 17:24:47 -0500 Subject: [PATCH] chore: add .pre-commit-config.yaml file docs(README.md): add badge for pre-commit & fix style of other badges docs(README.md): fix incorrect CONTRIBUTING linkinkg branch name The .pre-commit-config.yaml file is added to the project, which includes hooks for checking YAML and JSON files. This will help ensure the quality and consistency of these file formats. Additionally, the README.md file is updated to fix the link to the CONTRIBUTING guide, directing users to the CONTRIBUTING.md file in the main branch. This ensures that contributors have access to the most up-to-date instructions for helping the project grow. --- .pre-commit-config.yaml | 29 +++++++++++++++++++++++++++++ README.md | 18 ++++++++++-------- 2 files changed, 39 insertions(+), 8 deletions(-) create mode 100644 .pre-commit-config.yaml diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..7c925c2 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,29 @@ +# .pre-commit-config.yaml +repos: +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.4.0 # use `pre-commit autoupdate` to get the latest rev + hooks: + - id: check-yaml + - id: check-json +# - id: pretty-format-json +# - id: end-of-file-fixer +# - id: trailing-whitespace +ci: + autofix_prs: false +#- repo: https://github.com/pre-commit/mirrors-csslint +# rev: v1.0.5 # use `pre-commit autoupdate` to get the latest rev +# hooks: +# - id: csslint +#- repo: https://github.com/thibaudcolas/curlylint +# rev: v0.13.1 # use `pre-commit autoupdate` to get the latest rev +# hooks: +# - id: curlylint +#- repo: https://github.com/klieret/jekyll-relative-url-check +# rev: v2.0.1 # use `pre-commit autoupdate` to get the latest rev +# hooks: +# - id: jekyll-relative-url-check-html +# - id: jekyll-relative-url-check-markdown +#- repo: https://github.com/pre-commit/mirrors-prettier +# rev: v2.7.1 +# hooks: +# - id: prettier diff --git a/README.md b/README.md index 0e8cd16..71daf67 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@

- Deploy GitHub Pages - Test and Proof - Last Commit + Deploy GitHub Pages + Test and Proof + pre-commit.ci status + Last Commit
- Last Commit - Last Commit - Contributors + Website + Last Commit + Last Commit + Contributors

@@ -30,10 +32,10 @@ This project is intended to be open to all and a true community effort. Everyone > - Updating/improving our website, graphics, and logos (we suck) > - Writing code to [auto-publish entries](#174) on the anniversary of their passing > - Prioritize [adding people who are missing](https://github.com/restincode/restincode/issues?q=is%3Aissue+is%3Aopen+sort%3Acreated-asc+label%3A%22Add+Person%22) from the website, before prioritizing [people who are missing additional data](https://github.com/restincode/restincode/issues?q=is%3Aissue+is%3Aopen+sort%3Acreated-asc+label%3A%22Add+Data%22+label%3A%22Person+Added%22) to their bio -> +> > See our Ideas [discussions](https://github.com/restincode/restincode/discussions/categories/ideas?discussions_q=category%3AIdeas+) or [issue label](https://github.com/restincode/restincode/issues?q=is%3Aopen+is%3Aissue+label%3AIdeas) for more opportunities. -Please see our [CONTRIBUTING](https://github.com/restincode/restincode/blob/master/CONTRIBUTING.md) guide for instructions on how to help this project grow. +Please see our [CONTRIBUTING](https://github.com/restincode/restincode/blob/main/CONTRIBUTING.md) guide for instructions on how to help this project grow.