https://github.com/bcochofel/gh-project-cookiecutter
cookiecutter template for GitHub projects
https://github.com/bcochofel/gh-project-cookiecutter
Last synced: 4 months ago
JSON representation
cookiecutter template for GitHub projects
- Host: GitHub
- URL: https://github.com/bcochofel/gh-project-cookiecutter
- Owner: bcochofel
- License: mit
- Created: 2021-01-16T15:05:32.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-19T16:43:33.000Z (almost 2 years ago)
- Last Synced: 2024-11-25T14:47:26.099Z (over 1 year ago)
- Language: Shell
- Size: 21.5 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# gh-project-cookiecutter
[![pre-commit badge][pre-commit-badge]][pre-commit] [![Conventional commits badge][conventional-commits-badge]][conventional-commits] [![Keep a Changelog v1.1.0 badge][keep-a-changelog-badge]][keep-a-changelog] [![MIT License Badge][license-badge]][license]
## Usage
To use this repository as a GitHub project template:
```bash
pip install cookiecutter
cookiecutter gh:bcochofel/gh-project-cookiecutter
```
pre-commit hooks are installed using post hook.
Check [this](hooks/post_gen_project.sh) to see what else gets executed.
After creating your Github repository don't forget to set your remote origin and push.
## pre-commit hooks
Read the [pre-commit hooks](docs/pre-commit-hooks.md) document for more info.
## git-chglog
Read the [git-chglog](docs/git-chlog.md) document for more info.
[pre-commit]: https://github.com/pre-commit/pre-commit
[pre-commit-badge]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
[conventional-commits-badge]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-green.svg
[conventional-commits]: https://conventionalcommits.org
[keep-a-changelog-badge]: https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735
[keep-a-changelog]: https://keepachangelog.com/en/1.0.0/
[license]: ./LICENSE
[license-badge]: https://img.shields.io/badge/license-MIT-green.svg
[changelog]: ./CHANGELOG.md
[changelog-badge]: https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735