CONTRIBUTING.md

Contribution guide

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Adding a new write-up entry

1. Each CTF gets its own folder in the root of this repository. For example, ‘Foo Bar CTF 2014’ would get a folder named foo-bar-ctf-2014.
2. Every CTF challenge gets its own subfolder within that folder. For example, all files related to the ‘Foo Bar CTF 2014’ challenge named ‘Sucky sandbox’ would be located in foo-bar-ctf-2014/sucky-sandbox.
3. Every CTF challenge folder needs a Markdown-formatted README.md file, e.g. foo-bar-ctf-2014/sucky-sandbox/README.md. This file contains any details about the challenge, the main write-up itself, and links to other write-ups and resources. The folder should also contain the source files needed to reproduce the challenge.
4. Once you’re done adding the entry or making your changes, submit a pull request using the GitHub web interface.

Changing an existing entry

1. Feel free to make any changes you see fit. Add a link to a write-up on your blog, add missing source files, clarify explanations in the write-up, or — if you’ve found a better way to solve a challenge — simplify the existing solution.
2. Once you’re done, submit a pull request using the GitHub web interface.