Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
📚 Initial commit
  • Loading branch information
dhanvi committed Jan 2, 2018
0 parents commit 494f68c
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 0 deletions.
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,35 @@
# 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 2015’ would get a folder named `foo-bar-ctf-2015`.
2. Every CTF challenge gets its own subfolder within that folder with an appendix indicating its value. For example, all files related to the ‘Foo Bar CTF 2015’ challenge named ‘Sucky sandbox’, which is worth `150` points, would be located in `foo-bar-ctf-2015/sucky-sandbox-150`.
3. Every CTF challenge folder needs a Markdown-formatted `README.md` file, e.g. `foo-bar-ctf-2015/sucky-sandbox-150/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.
5. Finally, make sure you follow our committing rules

## 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.

## Committing rules
These rules exist to keep the repo maintainable and complete. Please consider following them.

1. Update the root `big-ctf/README.md` file, when adding a write-up to `big-ctf/task/`. We have three different sections:
* `Completed write-ups` - Tasks, for which there is at least one local repo write-up (see the `Write-up` section of each task)
* `External write-ups only` - Tasks, for which there is at least one external write-up (see the `Other write-ups and resources` section of each task, but no local write-up
* `Missing write-ups` - Tasks, for which there are no write-ups available (yet).
2. If there already exists a write-up in the `Write-up` section and you want to add another local write-up:
- Add another `Alternative write-up` section above the `Other write-ups and resources` section
3. Do not add files that have a filesize bigger than 15MB to keep the repo relatively small. Upload the file instead to a service or reference it from somewhere else.
4. Consider following these [committing rules](https://atom.io/docs/latest/contributing#git-commit-messages). For this repo, we like to use these [emojis](http://www.emoji-cheat-sheet.com/):
* :memo: when adding a write-up to the `Write-up` section of a task
* :floppy_disk: when adding resources for a task, e.g. files or scripts
* :link: when adding a write-up link to the `Other write-ups and resources` section of a task
* :pill: when fixing broken links or corrupt Markup stuff
* :books: when updating the structure of this repo or adding a ctf skeleton structure
* :fire: when deleting files
5. If you want to add a new CTF directory/structure (skeleton) with as little trouble as possible, then consider using the `genctf.py` tool from [our tools repo](https://github.com/ctfs/write-ups-tools/)
28 changes: 28 additions & 0 deletions README.md
@@ -0,0 +1,28 @@
# CTF write-ups 2017

[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg?maxAge=2592000)](https://gitter.im/ctfs/write-ups) [![Reddit](https://img.shields.io/badge/reddit-yes-blue.svg)](https://www.reddit.com/r/securityCTF) [![Twitter Follow](https://img.shields.io/twitter/follow/shields_io.svg?style=social&label=Follow&maxAge=2592000)](https://twitter.com/write_ups)


There are some problems with [CTF](https://ctftime.org/ctf-wtf/) 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-2018/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.

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md).

## Archive

* [Write-ups for CTFs that occurred in 2013](https://github.com/ctfs/write-ups-2013)
* [Write-ups for CTFs that occurred in 2014](https://github.com/ctfs/write-ups-2014)
* [Write-ups for CTFs that occurred in 2015](https://github.com/ctfs/write-ups-2015)
* [Write-ups for CTFs that occurred in 2016](https://github.com/ctfs/write-ups-2016)
* [Write-ups for CTFs that occurred in 2017](https://github.com/ctfs/write-ups-2017)
* [Write-ups for CTFs that occurred in 2018](https://github.com/ctfs/write-ups-2018) (this repository)

0 comments on commit 494f68c

Please sign in to comment.