Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Initial commit

  • Loading branch information...
commit 26dc94ab8c7c12ffb3e4ca1f6d06fdc679d23d6e 0 parents
@mathiasbynens mathiasbynens authored
Showing with 27 additions and 0 deletions.
  1. +15 −0 CONTRIBUTING.md
  2. +12 −0 README.md
15 CONTRIBUTING.md
@@ -0,0 +1,15 @@
+# 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. The folder may 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.
12 README.md
@@ -0,0 +1,12 @@
+# CTF write-ups
+
+There are some problems with CTF write-ups in general:
+
+* they’re scattered across the interwebs
+* they don’t usually include the original files needed to solve the challenge
+* some of them are incomplete or skip ‘obvious’ parts of the explanation, and are therefore not as helpful for newcomers
+* often they disappear when the owner forgets to renew their domain or shuts down their blog
+
+This repository aims to solve those problems.
+
+It’s a collection of CTF source files and write-ups that anyone can contribute to. Did you just publish a CTF write-up? [Let us know](https://github.com/ctfs/write-ups/issues/new), and we’ll add a link to your post — or just add the link yourself and submit a pull request. Spot an issue with a solution? Correct it, and send a pull request.
Please sign in to comment.
Something went wrong with that request. Please try again.