# github-template **Repository Path**: mirrors_OWASP/github-template ## Basic Information - **Project Name**: github-template - **Description**: Templates recommended for GitHub repositories of OWASP projects - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2020-08-19 - **Last Updated**: 2025-06-16 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # ![Project Logo](images/logo_100px.png) OWASP GitHub Template [![OWASP Incubator](https://img.shields.io/badge/owasp-incubator-blue.svg)](https://www.owasp.org/index.php/OWASP_Project_Inventory#tab=Incubator_Projects) [![GitHub release](https://img.shields.io/github/release/owasp/github-template.svg)](https://github.com/owasp/github-template/releases/latest) _**TODO:** Replace above logo with your own 100x100px logo. Also replace the [![OWASP Incubator](https://img.shields.io/badge/owasp-incubator-blue.svg)](https://www.owasp.org/index.php/OWASP_Project_Inventory#tab=Incubator_Projects) badge above with [![OWASP Labs](https://img.shields.io/badge/owasp-labs%20project-f7b73c.svg)](https://www.owasp.org/index.php/OWASP_Project_Inventory#tab=Labs_Projects) or [![OWASP Flagship](https://img.shields.io/badge/owasp-flagship%20project-38a047.svg)](https://www.owasp.org/index.php/OWASP_Project_Inventory#tab=Flagship_Projects) depending on your project maturity rating._ The OWASP GitHub Template is a copy&paste resource for OWASP projects to structure their `README.md` in order to provide a useful front-page documentation to users and potential contributors. _**TODO:** Replace with your own brief project description (3-5 lines)._ [![Build Status](https://travis-ci.org/owasp/github-template.svg?branch=master)](https://travis-ci.org/owasp/github-template) _**TODO:** Add other crucial overall status badges here. Context specific badges should go next to their section title, into [CONTRIBUTING.md](CONTRIBUTING.md) or into other sub-section files._ ![OWASP GitHub Template screenshot 1](images/screenshot1.png) ![OWASP GitHub Template screenshot 2](images/screenshot2.png) ![OWASP GitHub Template screenshot 3](images/screenshot3.png) _**TODO:** Replace screenshots above with your own._ For a detailed introduction, full list of features and technical overview please visit the official project page: ## Setup _**TODO:** Add instructions how to install and run the tool or how to integrate it into other software. If there are different options (e.g. cloning from GitHub & running a Docker container) explain each in their own sub-section._ ## Usage _**TODO:** Add instructions how to perform the typical use cases of the tool or library._ ## Additional Documentation _**TODO:** Add links to further documentation in this section. This can be a printed book, [GitBook](https://www.gitbook.com/@owasp), powerpoint slides, screencasts etc._ ## Troubleshooting [![Gitter](http://img.shields.io/badge/gitter-join%20chat-1dce73.svg)](https://gitter.im/owasp/github-template) If you need help with the setup please check the [TROUBLESHOOTING.md](TROUBLESHOOTING.md) or post your specific problem or question in the [official Gitter Chat](https://gitter.im/owasp/github-template). ## Contributing [![GitHub contributors](https://img.shields.io/github/contributors/owasp/github-template.svg)](https://github.com/owasp/github-template/graphs/contributors) [![Stories in Ready](https://badge.waffle.io/owasp/github-template.svg?label=ready&title=Ready)](http://waffle.io/owasp/github-template) Found a bug? Crashed the tool? Propose a new feature? Feel free to [create an issue](https://github.com/owasp/github-template/issues) or [post your ideas in the chat](https://gitter.im/owasp/github-template)! Pull requests are also highly welcome - please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for details. ## References Did you write a blog post, magazine article or do a podcast about or mentioning OWASP GitHub Template? Or maybe you held or joined a conference talk or meetup session, a hacking workshop or public training where this project was mentioned? Add it to our ever-growing list of [REFERENCES.md](REFERENCES.md) by forking and opening a Pull Request! ## Donations ### PayPal [![PayPal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=paypal%40owasp%2eorg&lc=BM&item_name=OWASP%20GitHub%20Template&item_number=OWASP%20Foundation&no_note=0¤cy_code=USD&bn=PP%2dDonationsBF) PayPal donations via above button go to the OWASP Foundations and are earmarked for "GitHub Template". This is the preferred way to support the project. _**TODO:** Add alternative ways to donate to the project financially here, e.g. BitCoin address or other micropayment provider links._ ## Credits _**TODO:** Add "special thanks to..."-like credits here. Please **do not add sponsors** here! These belong into the ["Acknowledgements" tab of your OWASP Project wiki page](https://www.owasp.org/index.php/OWASP_Juice_Shop_Project#tab=Acknowledgements) exclusively!_ ## Contributors _**TODO:** You can generate a list of contributors via various open source tools, e.g. `node-authors`_ Ordered by date of first contribution. [Auto-generated](https://github.com/dtrejo/node-authors) on Tue, 06 Jun 2017 00:00:00 GMT. - [Björn Kimminich](https://github.com/bkimminich) aka `bkimminich` ## Licensing [![license](https://img.shields.io/github/license/owasp/github-template.svg)](LICENSE) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fowasp%2Fgithub-template.svg?type=shield)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fowasp%2Fgithub-template?ref=badge_shield) This program is free software: you can redistribute it and/or modify it under the terms of the [MIT license](LICENSE). OWASP GitHub Template and any contributions are Copyright © by Bjoern Kimminich 2017. _**TODO:** Replace above text and the contents of the [LICENSE file](LICENSE) with [chosen open-source license](https://opensource.org/licenses)._ ![Project Logo](images/logo.png) _**TODO:** Replace with your own full-size logo._ _**TODO:** Replace all occurences of `GitHub Template` and `owasp/github-template` with your own project name and repository path._