Skip to content

Latest commit

 

History

History
98 lines (82 loc) · 4.29 KB

contributing.md

File metadata and controls

98 lines (82 loc) · 4.29 KB
Raw

Contributing

  • Your one stop shop for contributing!

How to Contribute

Creating a challenge

  • Be sure your flag looks like jctf{your_text_here}

  1. Go to Directory of category that you wish to create a challenge for

    Categories
    crypto
    forensics
    misc
    bin
    web
    osint

  2. Run python3 ../makeChallenge.py <ChallengeName> and this will automatically instantiate all the standardization to make a challenge.

    • NB: This assumes you have followed Step 1
    • Be sure that ChallengeName is one word (has no space) or encapsulated by single quotes
    • Feel free to add new files or folders that aren't part of the standardization process
      • Try not to deviate, unless necessary

  3. Once you finish to Remember to Append that Challenge to the README.md in that Category Directory based on Difficulty

    README.md's Categories
    crypto/README.md
    forensics/README.md
    misc/README.md
    bin/README.md
    web/README.md
    osint/README.md

Creating a writeup for a challenge

  • Helping both Beginners and More Seasoned Github Users

For Github Beginners

  1. Fork github repository
  2. (In a terminal) Clone forked repository and move to cloned Directory
    • git clone https://github.com/<your-username>/ctf-challenges.git
    • cd ctf-challenges
  3. Create and Switch to new branch
    • git checkout -b <branch name>
    • Preferably <branch name> is name challenge(s)
  4. Change Directory into writeups and into challenge that you have / want to make a write-up for
    • cd writeups/<challenge>
  5. Run python3 ../../createWriteup.py <Name/Handle>
    • This will create a structure that looks like this:
    +--- <challenge: dir>
|    \--- <name/handle: dir>
|         \--- <solution: dir>
|         +--- README.md
  6. Put all custom files / scripts that helped with the answering of the problem in the <solution> directory. Basically anything necessary goes in solution
  7. Document your method in the README.md file which is located in the <challenge>/<name/handle> directory
  8. Change Directory until you are at ctf-challegnges/writeups
  9. Git Add Files
    • git add .
  10. Git Commit
    • git commit -m "<Describe edits / commit>"
  11. Git Push
    • git push origin <branch name>
  12. With everything pushed onto Github, follow this last tutorial and you should be on your way!

For More Experienced Github Frequenters

  1. Create a fork of Github repo, and
  2. Change directory into writeups/<challenge>, with <challenge> being the challenge the writeup is written for
  3. Run python3 ../../createWriteup.py <Name/Handle>
    • This will standardized the writeups in the repository
  4. Dump any scripts/file in <solution> directory located in writeups/<challenge>/<Name/Handle>/<solution> and describe Method in writeups/<challenge>/<Name/Handle>/README.md
  5. Create a PR Request from
    • Note: Organizers may request edits on your PR
  6. Wait and Drink Campagne during the Code Review process (if you are of the legal age)
    • Note: Will probably only check if the proper steps have been taken to create the writeup

DM / PM any of the organizers to help with the writeup process

Resources

Last Resort

Contact Logan R#7154 or AndersOrve#9714 on Discord if clarification or help is needed