General Mattermost usage Guidelines for CTF competitions
authorGeorg Merzdovnik <georg.merzdovnik@gmail.com>
Fri, 18 Oct 2019 12:34:42 +0000 (14:34 +0200)
committerGeorg Merzdovnik <georg.merzdovnik@gmail.com>
Fri, 18 Oct 2019 12:34:42 +0000 (14:34 +0200)
mattermost_for_CTFs.md [new file with mode: 0644]

diff --git a/mattermost_for_CTFs.md b/mattermost_for_CTFs.md
new file mode 100644 (file)
index 0000000..b444a13
--- /dev/null
@@ -0,0 +1,29 @@
+## General Mattermost Usage Guidelines for CTFs
+
+Here are some infos on how we usually use Gitlab/Mattermost for collaboration during CTFs (If you have anything to add/change, feel free):
+
+
+### Please keep the `Town Square` clean.
+- Only post **game-relevant** infos there (like e.g. link to the scoreboard)
+  * If the Town-Square becomes cluttered during the event (like it usually does ;) ), we can fall back to pinning relevant messages to the channel.
+- For anything else (discussions/rants/questions/...)  please use the `Off-topic` channel
+
+
+### Create channels for challenges
+
+- If you start working on a challenge check if there is a channel already. Otherwise, create one 
+- This way others will know who is working or has worked on the challenge
+- A customary scheme we use is `<category>-<challenge name>` (e.g. `web-whatever`)
+  * the naming scheme is not that important but it should be somewhat consistent
+
+
+### Try to put as much information as possible in the channel
+- If you find out something useful or hit a dead end, put it in the channel. Maybe someone else can use it or provide additional help/information
+- Use [Mattermost Markdown](https://docs.mattermost.com/help/messaging/formatting-text.html) for text and code formatting
+
+
+### Use Gitlab for larger code-parts
++ Mattermost is fine for small code snippets, but if you want to collaborate on code it's most likely easier to use the Gitlab repository
+  - We do not really have a good git workflow, but placing stuff in `<category>/<challenge_name>`-folders should work okay
+
+