mafoo.org.uk/selfdefined
1
0
Fork 0
mirror of https://github.com/fooflington/selfdefined.git synced 2025-01-22 17:30:00 +00:00
Code Issues Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Ekaterina Mekhnetsova 2020-02-13 13:03:17 +03:00 committed by GitHub
parent 950925a255
commit ff63f7eb70
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -41,11 +41,13 @@ After you’ve forked the repo, you will need to write a definition. Good times.
Always remember that if you are unsure, you can first open an issue or create a PR with «WIP» in the title («WIP» stands for «work in progress») and ask for early feedback. For example, it might be called *«\[WIP\] Propose definition for spirit animal»*.
- Step 1: Create a file named `word.md` in in the [definitions folder](11ty/definitions/) where we store all definitions.
For this tutorial we will take the word «Obsessive Compulsive Disorder», as it allows us to show some of the features.
`word` should be the name of the word you are defining. Not `word`. Except you are defining «word». In this case it should be `word`.
- Step 1: Create a file named `word.md` in the [definitions folder](11ty/definitions/) where we store all definitions.
For this tutorial we will take the word «Obsessive Compulsive Disorder», as it allows us to show some of the features. That means we would create the file named `obsessive-compulsive-disorder.md` (as it is already defined, you can have a look at the [finished definition of «Obsessive Compulsive Disorder»](11ty/definitions/obsessive-compulsive-disorder.md)).
Replace `word` with the word or the phrase you are defining. Write it in all-lowercase letters with hyphens instead of spaces.
In our example, we would create the file named `obsessive-compulsive-disorder.md` (as it is already defined, you can have a look at the [finished definition of «Obsessive Compulsive Disorder»](11ty/definitions/obsessive-compulsive-disorder.md)).
- Step 2: Populate the file you created.