To contribute to the website with new features, improvements or UX/UI changes feel free to open an Issue.
You can fix bugs or typos by submiting a Pull Request.
To add or update content gathered on this website give a look at our tutorial for new contributors 🙂
...or directly open a Pull Request if you already know how these things work 😉
Content is placed under ./src/content
.
When contributing to the website's content, please try to follow the following guidelines.
Tags:
- Use already existing tags (mind tags proliferation)
- Use singular instead of plural --> TO FIX
- Most of the time use 2 to 5 tags
- No upper case except for acronyms and FR
- [Non-English]: Add an upper case tag for the language, for example
FR
for French
Title:
- Title should be straight to the point and explicit
- [Non-English]: Add an emoji flag for the language at the end
- [Write-Ups]: End title with
Write-Up <CTF> <YEAR>
Files:
- Use lower-case, dash-separated names
- Filenames will become URLs, they should be explicit, relatively short and close to article's title
- In case you have images: create a folder, place your article inside and name it
index.md
, an example
NOTE: called leaf bundle by HUGO - [Write-Ups]: Name the file
name-of-challenge-wu-<category>.md
(the category is optional)
Other:
- check emojis on https://gohugo.io/quick-reference/emojis/