diff --git a/README.md b/README.md index a9edd04..135ecb7 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ A good template for github repos with best practices adoption. [Here is a nice checklist](https://github.com/jlcanovas/gh-best-practices-template/blob/main/guidelines.md) of things to consider with a new repo. -## Contibuting +## Contributing - [Code of Conduct](.github/CODE_OF_CONDUCT.md) - [Contributing Guide](.github/CONTRIBUTING.md) includes a step-by-step guide to our diff --git a/docs/dev-process.cast b/docs/dev-process.cast index 64cf691..0a6ddcb 100644 --- a/docs/dev-process.cast +++ b/docs/dev-process.cast @@ -50,7 +50,7 @@ [10.979711, "o", "](.gitattributes) based on [gitattributes](https://github.com/gitattributes/gitattributes)\u001b[m\u001b[m\r\n - ✅ [gitignore](.gitignore) with comments\u001b[m\u001b[m\r\n\u001b[31m-- ✅ [Issue Templates](.github/ISSUE_TEMPLATE)\u001b[m\u001b[m\r\n\u001b[31m-- ✅ [PR Template](.github/pull_request_template.md)\u001b[m\u001b[m\r\n - ✅ [CODEOWNERS](.github/CODEOWNERS) that is self-documented\u001b[m\u001b[m\r\n - ✅ [justfile](justfile) with\u001b[m\u001b[m\r\n [command line workflow for pull requests](.github/CONTRIBUTING.md#development-process)\u001b[m\u001b[m\r\n - ✅ [Github Actions](.github/workflows) are already setup for:\u001b[m\u001b[m\r\n\u001b[31m- - ✅ [Markdownlint](https://github.com/DavidAnson/markdownlint-cli2-action) keeps your READMEs standards-compliant\u001b[m\u001b[m\r\n\u001b[32m+\u001b[m\u001b[32m - ✅ [Auto-assign](https://github.com/pozil/auto-assign-issue) helps avoid toil.\u001b[m\u001b[m\r\n - ✅ [Checkov](https://github.com/bridgecrewio/checkov) will help keep our github actions secure\u001b[m\u001b[m\r\n\u001b[32m+\u001b[m\u001b[32m - ✅ [Markdownlint](https://github.com/DavidAnson/markdownlint-cli2-action) keeps your READMEs standards"] [10.979755, "o", "-compliant\u001b[m\u001b[m\r\n - ✅ [A few extra labels for issues](https://github.com/fini-net/template-repo/labels)\u001b[m\u001b[m\r\n\u001b[31m-- ✅ [README](README.md) with badges\u001b[m\u001b[m\r\n \u001b[m\u001b[m\r\n ## Usage\u001b[m\u001b[m\r\n \u001b[m\u001b[m\r\n\u001b[36m@@ -33,8 +39,8 @@\u001b[m \u001b[m## Usage\u001b[m\u001b[m\r\n 1. Ditch the \"Template Status\", \"Usage\", and \"Kudos\" sections in the `README.md`.\u001b[m\u001b[m\r\n `just clean-readme` will give you a clean README, but there are other files to fix.\u001b[m\u001b[m\r\n \u001b[m\u001b[m\r\n\u001b[31m-[Here](https://github.com/jlcanovas/gh-best-practices-template/blob/main/guidelines.md)\u001b[m\u001b[m\r\n:\u001b[K"] [12.182114, "o", "\r\u001b[K"] -[12.182203, "o", "\u001b[31m-is a nice checklist of things to consider with a new repo.\u001b[m\u001b[m\r\n\u001b[32m+\u001b[m\u001b[32m[Here is a nice checklist](https://github.com/jlcanovas/gh-best-practices-template/blob/main/guidelines.md)\u001b[m\u001b[m\r\n\u001b[32m+\u001b[m\u001b[32mof things to consider with a new repo.\u001b[m\u001b[m\r\n \u001b[m\u001b[m\r\n ## Contibuting\u001b[m\u001b[m\r\n \u001b[m\u001b[m\r\n\u001b[7m(END)\u001b[27m\u001b[K"] +[12.182203, "o", "\u001b[31m-is a nice checklist of things to consider with a new repo.\u001b[m\u001b[m\r\n\u001b[32m+\u001b[m\u001b[32m[Here is a nice checklist](https://github.com/jlcanovas/gh-best-practices-template/blob/main/guidelines.md)\u001b[m\u001b[m\r\n\u001b[32m+\u001b[m\u001b[32mof things to consider with a new repo.\u001b[m\u001b[m\r\n \u001b[m\u001b[m\r\n ## Contributing\u001b[m\u001b[m\r\n \u001b[m\u001b[m\r\n\u001b[7m(END)\u001b[27m\u001b[K"] [12.648225, "o", "\r\u001b[K\u001b[?1l\u001b>"] [12.650468, "o", "\u001b[1m\u001b[7m%\u001b[27m\u001b[1m\u001b[0m \r \r"] [12.650761, "o", "\r\u001b[0m\u001b[27m\u001b[24m\u001b[Jtemplate-repo % \u001b[K\u001b[?2004h"] diff --git a/justfile b/justfile index 6b27d27..7afd76c 100644 --- a/justfile +++ b/justfile @@ -35,7 +35,7 @@ clean_readme: A good starting place for something. (TODO) - ## Contibuting + ## Contributing - [Code of Conduct](.github/CODE_OF_CONDUCT.md) - [Contributing Guide](.github/CONTRIBUTING.md) includes a step-by-step guide to our