From 245db1d307a81bfe767cb169b30eeea8de965437 Mon Sep 17 00:00:00 2001 From: marshmallow Date: Tue, 13 Sep 2022 18:16:53 +1000 Subject: [PATCH] Create README.md Signed-off-by: marshmallow --- .github/README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 .github/README.md diff --git a/.github/README.md b/.github/README.md new file mode 100644 index 0000000..a243ed0 --- /dev/null +++ b/.github/README.md @@ -0,0 +1,37 @@ +# Contributing + +## Entries + +Start every new entry with +```markdown +--- +title: An Important Entry ✅ +--- + +Content +``` + +NOT + +```markdown +--- +title: An Important Entry +--- + +# An Important Entry ❌ + +Content +``` + +## Filenames + +Use Kebab case for filenames +| ❌ | ✅ | +| :------------------: |:--------------------:| +| `an_important_entry` | `an-important-entry` | + +Ignore for directories for now + +## Directories + +Do not create directories any deeper than 1. Only top level directories for different projects.