[go: nahoru, domu]

Skip to content

Commit

Permalink
📚 Update root README.md and CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
YASME-Tim committed Jan 23, 2015
1 parent b631271 commit 4f66397
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,28 @@ Please take a moment to review this document in order to make the contribution p
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.
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 writeup to `big-ctf/task/`. We have three different sections:
* `Completed write-ups` - Tasks, for which there is at least one local repo writeup (see the `Write-up` section of each task)
* `External write-ups only` - Tasks, for which there is at least one external writeup (see the `Other write-ups and resources` section of each task, but no local writeup
* `Missing write-ups` - Tasks, for which there are no writeups available (yet).


2. If there already exists a writeup in the `Write-up` section and you want to add another local writeup:
- 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 writeup 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 writeup 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
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,11 @@ 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.

## Contributing

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

## Archive

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

0 comments on commit 4f66397

Please sign in to comment.