Name: github-template
Owner: OWASP
Description: Templates recommended for GitHub repositories of OWASP projects
Created: 2017-06-06 06:55:36.0
Updated: 2018-03-25 19:17:30.0
Pushed: 2017-06-08 08:36:12.0
Homepage: null
Size: 397
Language: null
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
OWASP GitHub Template 
TODO: Replace above logo with your own 100x100px logo. Also
replace the
badge above with
or
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).
TODO: Add other crucial overall status badges here. Context
specific badges should go next to their section title, into
CONTRIBUTING.md or into other sub-section files.
TODO: Replace screenshots above with your own.
For a detailed introduction, full list of features and technical overview please visit the official project page: https://www.owasp.org/index.php/OWASP_GitHub_Template_Project
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.
TODO: Add instructions how to perform the typical use cases of the tool or library.
TODO: Add links to further documentation in this section. This can be a printed book, GitBook, powerpoint slides, screencasts etc.
If you need help with the setup please check the TROUBLESHOOTING.md or post your specific problem or question in the official Gitter Chat.
Found a bug? Crashed the tool? Propose a new feature?
Feel free to create an issue or post your ideas in the chat! Pull requests are also highly welcome - please refer to CONTRIBUTING.md for details.
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 by forking and opening a Pull Request!
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.
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 exclusively!
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 on Tue, 06 Jun 2017 00:00:00 GMT.
bkimminich
This program is free software: you can redistribute it and/or modify it under the terms of the MIT license. OWASP GitHub Template and any contributions are Copyright © by Bjoern Kimminich 2017.
TODO: Replace above text and the contents of the LICENSE file with chosen open-source license.
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.