Free · open source · MIT · Templates

Documentation templates for GitHub

The basics to make your repository trustworthy: README, contributing guide and issue forms.

The problem

A repository without a README or a contributing guide doesn't inspire trust: people don't know how to install it, open issues without details and send pull requests their own way. Writing all that from scratch is tedious and gets put off. These templates include a library README, a CONTRIBUTING.md with a branching workflow, an issue form for bugs and a pull request template with a checklist.

What’s included

Library README
CONTRIBUTING.md with a branching workflow and Conventional Commits
Issue form for bugs
Pull request template with a checklist

Install it in one minute

git clone https://github.com/carlosp5751258-lgtm/ctrlia-plantillas-docs-github.git
cp -r ctrlia-plantillas-docs-github/.github .
cp ctrlia-plantillas-docs-github/CONTRIBUTING.md .
cp ctrlia-plantillas-docs-github/readme/README-libreria.md README.md

ctrlia-plantillas-docs-githubCode, README and MIT license on GitHub

License: MIT · use, modify and share it, including in commercial projects.