Home

Awesome

<img src="project-logo.png" align="left" width="192px" height="192px"/> <img align="left" width="0" height="192px" hspace="10"/>

Template files for writing maintanable GitHub projects. Make your repo pretty!

Under Development Public Domain Travis

So you had an idea and developed the next world's industry-changing application. You decided to open-source it because you're way cool. Now you need to educate people about your project and need some docs to get started. You got it. :alien:

<br> <p align="center"> <strong>Templates included:</strong> <a href="/.github/README.md">README</a> • <a href="/.github/CONTRIBUTING.md">CONTRIBUTING </a> • <a href="/.github/PULL_REQUEST_TEMPLATE.md">PULL REQUEST</a> • <a href="/.github/ISSUE_TEMPLATE.md">ISSUE TEMPLATE</a> • <a href="/.github/CONTRIBUTORS.md">CONTRIBUTORS</a> </p> <br>

Installing

Clone this project and name it accordingly:

git clone git@github.com:cezaraugusto/github-template-guidelines.git MY-PROJECT-NAME && cd MY-PROJECT-NAME

Getting Started

This project is a collection of boilerplate (template) files with resumed guidelines for README, CONTRIBUTING and CONTRIBUTORS documentation. It also includes a basic ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE which are now allowed by GitHub. All templates are filled under .github/ folder. This README itself is a fork of the README template.

Usage

  1. After installing, remove this file rm README.md.
  2. Move the README template file located under .github/ to the main directory mv .github/README.md . :cool:
  3. Follow the basic usage guidelines in each file or make it your way. The world is yours.

Useful Resources :thumbsup:

References for starting a Project

README References

CONTRIBUTING References

CHANGELOG References

This boilerplate intentionally did not provide any CHANGELOG file as example, since this tool could make it automatically, fulfilling the file's objective. If you still want to keep it handwritten, to keep you (and your project) sane, I'd recommend you to follow the references below:

ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE References

CONTRIBUTORS References

Contributors

<!-- Contributors START Cezar_Augusto cezaraugusto http://cezaraugusto.net doc example prReview Nathalia_Bruno nathaliabruno http://nathaliabruno.com doc prReview Billie_Thompson PurpleBooth http://purplebooth.co.uk example Contributors END --> <!-- Contributors table START -->
Cezar Augusto<br /><sub>Cezar Augusto</sub><br />📖 💡 👀Nathalia Bruno<br /><sub>Nathalia Bruno</sub><br />📖 👀Billie Thompson<br /><sub>Billie Thompson</sub><br />💡
<!-- Contributors table END -->

This project follows the all-contributors specification. Contributions of any kind welcome!

License

CC0

To the extent possible under law, Cezar Augusto has waived all copyright and related or neighboring rights to this work.