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
fpgmaas · May 14, 2022 · d6eec90 · d6eec90
1 parent 2be2724
commit d6eec90
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git 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
@@ -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**: <https://github.com/fpgmaas/{{cookiecutter.project_name}}/>
-- **Documentation** <https://fpgmaas.github.io/{{cookiecutter.project_name}}/>
+- **Github repository**: <https://github.com/{{cookiecutter.author_github_handle}}/{{cookiecutter.project_name}}/>
+- **Documentation** <https://{{cookiecutter.author_github_handle}}.github.io/{{cookiecutter.project_name}}/>
 
 ## Releasing a new version