Create README.md

Signed-off-by: marshmallow <marshycity@gmail.com>
pull/4/head
marshmallow 2 years ago
parent 23672ac09c
commit 245db1d307

37
.github/README.md vendored

@ -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.
Loading…
Cancel
Save