From d6eec901cfa2d1b9d0d7a25e22214d74527f67a7 Mon Sep 17 00:00:00 2001 From: Brad Hjelmar Date: Sat, 14 May 2022 12:29:17 -0400 Subject: [PATCH] add github author handle to README.md for shield links (#38) * add github author handle to README.md for shield links * changed link to check in CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- {{cookiecutter.project_name}}/README.md | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c17eff9..b45966c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,7 +99,7 @@ Now you can make your changes locally. formatting tests. ``` bash -make lint +make check ``` 7. Now, validate that all unit tests are passing: diff --git a/{{cookiecutter.project_name}}/README.md b/{{cookiecutter.project_name}}/README.md index 0c8f022..254d7b1 100644 --- a/{{cookiecutter.project_name}}/README.md +++ b/{{cookiecutter.project_name}}/README.md @@ -1,17 +1,17 @@ # {{cookiecutter.project_name}} -[![Release](https://img.shields.io/github/v/release/fpgmaas/{{cookiecutter.project_name}})](https://img.shields.io/github/v/release/fpgmaas/{{cookiecutter.project_name}}) -[![Build status](https://img.shields.io/github/workflow/status/fpgmaas/{{cookiecutter.project_name}}/merge-to-main)](https://img.shields.io/github/workflow/status/fpgmaas/{{cookiecutter.project_name}}/merge-to-main) -[![Commit activity](https://img.shields.io/github/commit-activity/m/fpgmaas/{{cookiecutter.project_name}})](https://img.shields.io/github/commit-activity/m/fpgmaas/{{cookiecutter.project_name}}) -[![Docs](https://img.shields.io/badge/docs-gh--pages-blue)](https://fpgmaas.github.io/{{cookiecutter.project_name}}/) +[![Release](https://img.shields.io/github/v/release/{{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}})](https://img.shields.io/github/v/release/{{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}}) +[![Build status](https://img.shields.io/github/workflow/status/{{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}}/merge-to-main)](https://img.shields.io/github/workflow/status/{{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}}/merge-to-main) +[![Commit activity](https://img.shields.io/github/commit-activity/m/{{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}})](https://img.shields.io/github/commit-activity/m/{{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}}) +[![Docs](https://img.shields.io/badge/docs-gh--pages-blue)](https://{{cookiecutter.author_github_handle}}.github.io/{{cookiecutter.project_name}}/) [![Code style with black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Imports with isort](https://img.shields.io/badge/%20imports-isort-%231674b1)](https://pycqa.github.io/isort/) -[![License](https://img.shields.io/github/license/fpgmaas/{{cookiecutter.project_name}})](https://img.shields.io/github/license/fpgmaas/{{cookiecutter.project_name}}) +[![License](https://img.shields.io/github/license/{{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}})](https://img.shields.io/github/license/{{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}}) {{cookiecutter.project_description}} -- **Github repository**: -- **Documentation** +- **Github repository**: +- **Documentation** ## Releasing a new version