{"id":13765173,"url":"https://github.com/cezaraugusto/github-template-guidelines","last_synced_at":"2025-04-13T04:12:14.941Z","repository":{"id":44470730,"uuid":"51109642","full_name":"cezaraugusto/github-template-guidelines","owner":"cezaraugusto","description":"Guidelines for building GitHub templates.","archived":false,"fork":false,"pushed_at":"2016-06-13T23:10:24.000Z","size":204,"stargazers_count":239,"open_issues_count":0,"forks_count":110,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-24T09:38:17.187Z","etag":null,"topics":["docs","documentation","github","guidelines","issue-template","pull-request-template","reference","template"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cezaraugusto.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-02-04T22:15:05.000Z","updated_at":"2025-02-04T19:36:15.000Z","dependencies_parsed_at":"2022-09-15T01:57:12.973Z","dependency_job_id":null,"html_url":"https://github.com/cezaraugusto/github-template-guidelines","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cezaraugusto%2Fgithub-template-guidelines","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cezaraugusto%2Fgithub-template-guidelines/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cezaraugusto%2Fgithub-template-guidelines/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cezaraugusto%2Fgithub-template-guidelines/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cezaraugusto","download_url":"https://codeload.github.com/cezaraugusto/github-template-guidelines/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248661721,"owners_count":21141451,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs","documentation","github","guidelines","issue-template","pull-request-template","reference","template"],"created_at":"2024-08-03T16:00:35.080Z","updated_at":"2025-04-13T04:12:14.913Z","avatar_url":"https://github.com/cezaraugusto.png","language":null,"readme":"\u003cimg src=\"project-logo.png\" align=\"left\" width=\"192px\" height=\"192px\"/\u003e\n\u003cimg align=\"left\" width=\"0\" height=\"192px\" hspace=\"10\"/\u003e\n\n\u003e Template files for writing maintanable GitHub projects. Make your repo pretty!\n\n[![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)\n\nSo 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:\n\n\u003cbr\u003e\n\u003cp align=\"center\"\u003e\n\u003cstrong\u003eTemplates included:\u003c/strong\u003e\n\u003ca href=\"/.github/README.md\"\u003eREADME\u003c/a\u003e • \u003ca href=\"/.github/CONTRIBUTING.md\"\u003eCONTRIBUTING \u003c/a\u003e • \u003ca href=\"/.github/PULL_REQUEST_TEMPLATE.md\"\u003ePULL REQUEST\u003c/a\u003e • \u003ca href=\"/.github/ISSUE_TEMPLATE.md\"\u003eISSUE TEMPLATE\u003c/a\u003e • \u003ca href=\"/.github/CONTRIBUTORS.md\"\u003eCONTRIBUTORS\u003c/a\u003e\n\u003c/p\u003e\n\u003cbr\u003e\n\n## Installing\n\nClone this project and name it accordingly:\n\n``git clone git@github.com:cezaraugusto/github-template-guidelines.git MY-PROJECT-NAME \u0026\u0026 cd MY-PROJECT-NAME``\n\n# Getting Started\n\nThis 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).\n\n## Usage\n\n1. After installing, remove this file `rm README.md`.\n2. Move the `README` template file located under `.github/` to the main directory `mv .github/README.md .` :cool:\n3. Follow the basic usage guidelines in each file or make it your way. *The world is yours*.\n\n## Useful Resources :thumbsup:\n\n\u003e References for starting a Project\n\n* [Helping people contribute to your Project](https://help.github.com/articles/helping-people-contribute-to-your-project/)\n* [Am I Ready to Open Source it?](https://gist.github.com/PurpleBooth/6f1ba788bf70fb501439#file-am-i-ready-to-open-source-this-md)\n\n\u003e `README` References\n\n* [How To Write A Readme](http://jfhbrook.github.io/2011/11/09/readmes.html)\n* [How to Write a Great Readme](https://robots.thoughtbot.com/how-to-write-a-great-readme)\n* [Eugene Yokota - StackOverflow Answer](http://stackoverflow.com/a/2304870)\n\n\u003e `CONTRIBUTING` References\n\n* [Setting Guidelines for Repository Contributors](https://help.github.com/articles/setting-guidelines-for-repository-contributors/)\n* [Contributor Covenant](http://contributor-covenant.org/)\n\n\u003e `CHANGELOG` References\n\n\u003e 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:\n\n* [Semantic Versioning 2.0.0](http://semver.org/)\n* [Keep a Changelog](http://keepachangelog.com/)\n\n\u003e `ISSUE_TEMPLATE` and `PULL_REQUEST_TEMPLATE` References\n\n* [Creating an Issue Template for your repository](https://help.github.com/articles/creating-an-issue-template-for-your-repository/)\n* [Creating a Pull Request Template for your repository](https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/)\n* [Awesome GitHub Templates](https://github.com/devspace/awesome-github-templates)\n\n\u003e `CONTRIBUTORS` References\n\n* [All Contributors](https://github.com/kentcdodds/all-contributors/)\n* [All Contributors (CLI)](https://github.com/jfmengels/all-contributors-cli)\n\n## Contributors\n\n\u003c!-- Contributors START\nCezar_Augusto cezaraugusto http://cezaraugusto.net doc example prReview\nNathalia_Bruno nathaliabruno http://nathaliabruno.com doc prReview\nBillie_Thompson PurpleBooth http://purplebooth.co.uk example\nContributors END --\u003e\n\n\u003c!-- Contributors table START --\u003e\n| [![Cezar Augusto](https://avatars.githubusercontent.com/cezaraugusto?s=100)\u003cbr /\u003e\u003csub\u003eCezar Augusto\u003c/sub\u003e](http://cezaraugusto.net)\u003cbr /\u003e[📖](git@github.com:cezaraugusto/You-Dont-Know-JS/commits?author=cezaraugusto) 💡 👀 | [![Nathalia Bruno](https://avatars.githubusercontent.com/nathaliabruno?s=100)\u003cbr /\u003e\u003csub\u003eNathalia Bruno\u003c/sub\u003e](http://nathaliabruno.com)\u003cbr /\u003e[📖](git@github.com:cezaraugusto/You-Dont-Know-JS/commits?author=nathaliabruno) 👀 | [![Billie Thompson](https://avatars.githubusercontent.com/PurpleBooth?s=100)\u003cbr /\u003e\u003csub\u003eBillie Thompson\u003c/sub\u003e](http://purplebooth.co.uk)\u003cbr /\u003e💡 |\n| :---: | :---: | :---: |\n\u003c!-- Contributors table END --\u003e\n\nThis project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.\nContributions of any kind welcome!\n\n## License\n[![CC0](https://i.creativecommons.org/p/zero/1.0/88x31.png)](https://creativecommons.org/publicdomain/zero/1.0/)\n\nTo the extent possible under law, [Cezar Augusto](http://cezaraugusto.net) has waived all copyright and related or neighboring rights to this work.\n","funding_links":[],"categories":["Resources for those already familiar with GitHub","Tools","GitHub","Others"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcezaraugusto%2Fgithub-template-guidelines","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcezaraugusto%2Fgithub-template-guidelines","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcezaraugusto%2Fgithub-template-guidelines/lists"}