Skip to content

Latest commit

 

History

History

github-repo

README.md

Contributors Forks Stargazers Issues GPL3 License LinkedIn Ask Me Anything


Logo

GitHub Repo Cookiecutter Template

This is a template to be used with cookiecuter to create a github repo
Explore the docs »
Report Bug · Request Feature

Table of Contents

About The Project

Built With

  • Cookiecutter
  • Python
  • YAML
  • Pre-Commit

Getting Started

Prerequisites

  • cookiecutter
  • pre-commit

Installation

  • cookiecutter ==> $ pip3 install cookiecutter
  • pre-commit ==> $ pip3 install pre-commit

Usage

To initialize the role with cookiecuter

$ cookiecutter gh:stiliajohny/cookiecutter-collection --directory="github-repo"

What this template provides?

  • Initialize a new git repo in the local machine
  • Add .yamllint config file (used by molecule)
  • Add .pre-commit-config.yaml used by pre-commit
  • Add .gitignore with common files I don't want to track in git
  • Add README.md and _config.yml for Github Pages

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

Contact

John Stilia - stilia.johny@gmail.com

Acknowledgements