Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

59 lines (43 loc) · 2.79 KB
Raw

Contribution Guidelines

Thanks for taking the time to contribute!

The following is a set of guidelines for contributing to SecDevLabs. These are just guidelines, not rules, so use your best judgement and feel free to propose changes to this document in a pull request! 😃

So... I built this app, it looks great, but how can I send it to SecDevLabs?

Well, a good place to start is to make sure you can deploy your app with Docker-Compose. All the apps in SecDevLabs are built with it in order to ensure you can get right into the action! If you need help, make sure to check Docker Compose Getting Started and Compose File Reference for a detailed look at docker-compose.yml file structure. ✓

So your app can be deployed with Docker-Compose, nice job! But wait, does it have a Makefile? If it doesn't, be sure to have a look here, we have a template you can follow or you can create your own! ✓

Ok, my app is looking awesome and all set up with Docker-Compose, what else do I need to send it?

It would be awesome if you could follow this basic suggested skeleton for your app, as all others conform to this template:

├── owasp-top10-2017-apps
│   ├── a#
        ├── MY-APP
            ├── app
                ├── myApp.go
            ├── deployments
                ├── Dockerfile
                ├── check-init.sh
                ├── docker-compose.yml
            ├── images
                ├── image1.jpg
                ├── image2.jpg
            ├── .gitignore
            ├── Makefile
            ├── README.md
├── docs
├── images
├── LICENSE.md
├── README.md
└── .gitignore

Do you have a README file? If you don't, have a look at our README template!

Be sure to add some pictures! A picture is worth a thousand words! 👍

I've found an error on one of the apps!

Please let us know! Send a Pull Request with the bug 🕷 label or create an Issue! We have a PR and issue template to help you!

Contribution Scope

This repository's goal is to provide a laboratory for people worldwide to learn more about cybersecurity and secure development. With that in mind, we expect contributions such as new applications, tweaks on the ones already existing or a bug catch.

To build some of the secDevLabs apps, some third party code, such as libraries or Content Management Systems (CMS), was used. Improving and maintaining external code is not the goal of this project and, in this regard, all contributions on that matter will be considered invalid.