Contribute 🚀

Gitflow

If you desire to contribute to the repository, first, you have to create an issue with the related branch. We do NOT push on the main branch. Then, in your favorite IDE, select the branch you just created using Github and start committing and pushing. When you are done, submit a pull request and notify one or more reviewers.

Step 1

Step 2

Step 3

Fill in the title with the correct format (FEAT, REFACTOR, BUG, ...), description, labels.

Step 4

Create de branch by clicking here

Step 5

When you are done with your commits you can push it to your new branch and visit Github again

Step 6

Fill in all fields

Step 7

If your pull request is accepted, the issue and the branch will be closed automatically.

Commit format

Please use conventional commits for your commits !

Adding new CTFs and writeups

Use the standard Hugo commands for creating new content:

hugo new --kind ctf <ctf_name>
hugo new <ctf_name>/<writeup_name>.md
# test hugo site locally:
hugo server
# might need this sometimes:
hugo server --disableFastRender