Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cezaraugusto/github-template-guidelines

Guidelines for building GitHub templates.
https://github.com/cezaraugusto/github-template-guidelines

docs documentation github guidelines issue-template pull-request-template reference template

Last synced: 12 days ago
JSON representation

Guidelines for building GitHub templates.

Host: GitHub
URL: https://github.com/cezaraugusto/github-template-guidelines
Owner: cezaraugusto
Created: 2016-02-04T22:15:05.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2016-06-13T23:10:24.000Z (over 8 years ago)
Last Synced: 2024-10-23T00:04:55.389Z (21 days ago)
Topics: docs, documentation, github, guidelines, issue-template, pull-request-template, reference, template
Homepage:
Size: 199 KB
Stars: 235
Watchers: 5
Forks: 109
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md

Awesome Lists containing this project

awesome-github - GitHub Template Guidelines
jimsghstars - cezaraugusto/github-template-guidelines - Guidelines for building GitHub templates. (Others)

README

        



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

[![Under Development](https://img.shields.io/badge/under-development-orange.svg)](https://github.com/cezaraugusto/github-template-guidelines) [![Public Domain](https://img.shields.io/badge/public-domain-lightgrey.svg)](https://creativecommons.org/publicdomain/zero/1.0/) [![Travis](https://img.shields.io/travis/cezaraugusto/github-template-guidelines.svg)](http://github.com/cezaraugusto/github-template-guidelines)

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:






Templates included:

README • CONTRIBUTING  • PULL REQUEST • ISSUE TEMPLATE • CONTRIBUTORS






## Installing

Clone this project and name it accordingly:

``git clone [email protected]:cezaraugusto/github-template-guidelines.git MY-PROJECT-NAME && cd MY-PROJECT-NAME``

# Getting Started

This project is a collection of [boilerplate](http://whatis.techtarget.com/definition/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](https://github.com/blog/2111-issue-and-pull-request-templates). All templates are filled under `.github/` folder. This `README` itself is a fork of the `README` [template](.github/README.md).

## 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

* [Helping people contribute to your Project](https://help.github.com/articles/helping-people-contribute-to-your-project/)

* [Am I Ready to Open Source it?](https://gist.github.com/PurpleBooth/6f1ba788bf70fb501439#file-am-i-ready-to-open-source-this-md)

> `README` References

* [How To Write A Readme](http://jfhbrook.github.io/2011/11/09/readmes.html)

* [How to Write a Great Readme](https://robots.thoughtbot.com/how-to-write-a-great-readme)

* [Eugene Yokota - StackOverflow Answer](http://stackoverflow.com/a/2304870)

> `CONTRIBUTING` References

* [Setting Guidelines for Repository Contributors](https://help.github.com/articles/setting-guidelines-for-repository-contributors/)

* [Contributor Covenant](http://contributor-covenant.org/)

> `CHANGELOG` References

> This boilerplate intentionally did not provide any `CHANGELOG` file as example, since [this tool](https://github.com/skywinder/github-changelog-generator) 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](http://semver.org/)

* [Keep a Changelog](http://keepachangelog.com/)

> `ISSUE_TEMPLATE` and `PULL_REQUEST_TEMPLATE` References

* [Creating an Issue Template for your repository](https://help.github.com/articles/creating-an-issue-template-for-your-repository/)

* [Creating a Pull Request Template for your repository](https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/)

* [Awesome GitHub Templates](https://github.com/devspace/awesome-github-templates)

> `CONTRIBUTORS` References

* [All Contributors](https://github.com/kentcdodds/all-contributors/)

* [All Contributors (CLI)](https://github.com/jfmengels/all-contributors-cli)

## Contributors

| [![Cezar Augusto](https://avatars.githubusercontent.com/cezaraugusto?s=100)
_{Cezar Augusto}](http://cezaraugusto.net)
[📖]([email protected]:cezaraugusto/You-Dont-Know-JS/commits?author=cezaraugusto) 💡 👀 | [![Nathalia Bruno](https://avatars.githubusercontent.com/nathaliabruno?s=100)
_{Nathalia Bruno}](http://nathaliabruno.com)
[📖]([email protected]:cezaraugusto/You-Dont-Know-JS/commits?author=nathaliabruno) 👀 | [![Billie Thompson](https://avatars.githubusercontent.com/PurpleBooth?s=100)
_{Billie Thompson}](http://purplebooth.co.uk)
💡 |

| :---: | :---: | :---: |

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.

Contributions of any kind welcome!

## License

[![CC0](https://i.creativecommons.org/p/zero/1.0/88x31.png)](https://creativecommons.org/publicdomain/zero/1.0/)

To the extent possible under law, [Cezar Augusto](http://cezaraugusto.net) has waived all copyright and related or neighboring rights to this work.