README.md

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

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. 👽

Templates included: README • CONTRIBUTING • PULL REQUEST • ISSUE TEMPLATE • CONTRIBUTORS

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 . 🆒
3. Follow the basic usage guidelines in each file or make it your way. The world is yours.

Useful Resources 👍

References for starting a Project

• Helping people contribute to your Project
• Am I Ready to Open Source it?

README References

• How To Write A Readme
• How to Write a Great Readme
• Eugene Yokota - StackOverflow Answer

CONTRIBUTING References

• Setting Guidelines for Repository Contributors
• Contributor Covenant

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:

• Semantic Versioning 2.0.0
• Keep a Changelog

ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE References

• Creating an Issue Template for your repository
• Creating a Pull Request Template for your repository
• Awesome GitHub Templates

CONTRIBUTORS References

• All Contributors
• All Contributors (CLI)

Contributors

Cezar Augusto 📖 💡 👀	Nathalia Bruno 📖 👀	Billie Thompson 💡

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

License

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