diff --git a/COMMUNITY.md b/COMMUNITY.md index caf83e8..fb3d2af 100644 --- a/COMMUNITY.md +++ b/COMMUNITY.md @@ -59,7 +59,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on the release process. TODO: A list of CONTRIBUTORS is generated below using contributors.yml located in the workflows directory. In order to automatically update the COMMUNITY.md, you must enter a secret into your Secrets and Variables under Actions within your repository settings. The name of the secret must be PUSH_TO_PROTECTED_BRANCH and the value must be a Personal Access Token with specific permissions. Please follow [this link](https://github.com/CasperWA/push-protected?tab=readme-ov-file#notes-on-token-and-user-permissions) for more information. -Total number of contributors: +![](https://img.shields.io/github/contributors/{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}?style=flat-square&label=Contributor%20Count(incl.%20bots)) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b9cefa9..5604ca1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ you'll be politely asked to change something. We appreciate all friendly contributions. We encourage you to read this project's CONTRIBUTING policy (you are here), its -[LICENSE](LICENSE.md), and its [README](README.md). +[LICENSE](LICENSE), and its [README](README.md). --> ## Getting Started diff --git a/README.md b/README.md index b4fa932..6e2ab44 100644 --- a/README.md +++ b/README.md @@ -3,23 +3,18 @@ {{ cookiecutter.project_description }} ## About the Project - -**{project statement}** + ### Project Vision - -**{project vision}** + ### Project Mission - -**{project mission}** + ### Agency Mission - ### Team Mission - ## Core Team @@ -31,6 +26,24 @@ A list of core team members responsible for the code and documentation in this r TODO: Including the repository structure helps viewers quickly understand the project layout. Using the "tree -d" command can be a helpful way to generate this information, but, be sure to update it as the project evolves and changes over time. +To install the tree command: +In the command line +- MacOS: +``` +brew install tree +``` + +- Linux: +``` +sudo apt-get update +sudo apt-get install tree +``` + +Windows: +``` +choco install tree +``` + **{list directories and descriptions}** TODO: Add a 'table of contents" for your documentation. Tier 0/1 projects with simple README.md files without many sections may or may not need this, but it is still extremely helpful to provide "bookmark" or "anchor" links to specific sections of your file to be referenced in tickets, docs, or other communication channels. @@ -39,15 +52,24 @@ TODO: Add a 'table of contents" for your documentation. Tier 0/1 projects with s --> - ## Local Development ## Coding Style and Linters