CONTRIBUTING.md

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 get right into the action! ✓

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?

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

Just 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!