[Owasp-leaders] Draft proposal for GitHub template: https://github.com/OWASP/github-template

Bjoern Kimminich bjoern.kimminich at owasp.org
Tue Jun 6 09:36:36 UTC 2017


Dear all,

 

I created a repo https://github.com/OWASP/github-template that could be used
as a copy&paste-source* for projects under OWASP's GitHub organization. It
comes with a pre-sectioned README.md and several (optional) files for a
project's contribution guide, troubleshooting section and project
references. The template is based on my own Juice Shop project repositories,
so please refer to these as live examples to determine if you like the
structure or not:

 

*	https://github.com/bkimminich/juice-shop (extensive documentation,
large project, uses all proposed sub-files to externalize content off the
README)
*	https://github.com/bkimminich/juice-shop-ctf (tiny side-repo, uses
inline sections over sub-files)

 

Your PRs, feedback, constructive criticism and other input is most welcome
to give us something to discuss during the "GitHub Organization Reboot"
working session during the upcoming OWASP Summit 2017:
https://owaspsummit.org/Working-Sessions/Owasp-Projects/GitHub-OrgReboot.htm
l.

 

Cheers,

Bjoern

 

*when you create a new project, simply unpack all the files from
https://github.com/OWASP/github-template/archive/master.zip into your new
empty repo, replace "GitHub Template" with your own project name and follow
the {{TODO: .} instructions! For now this is only a working draft of a
template, nothing about it is mandatory at this point.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.owasp.org/pipermail/owasp-leaders/attachments/20170606/98bc4e89/attachment-0001.html>


More information about the OWASP-Leaders mailing list