You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+12-12
Original file line number
Diff line number
Diff line change
@@ -16,9 +16,20 @@ Please note that by participating, you are expected to uphold the [Contributor C
16
16
17
17
---
18
18
19
+
## Terms
20
+
21
+
Here are some terms that we will use in this repo:
22
+
23
+
-`path` needs a leading slash. This will be slug of the lesson
24
+
-`title`- will be the title displayed on the `Table of Contents` and on the page itself
25
+
-`order`- the order of which the item should appear in the table of contents. should in `<Number><Capital-letter>` format where the number corresponds to the section itself and the letter corresponds to the order of the lesson inside the section, e.g. 3B means under the section 3 and the order of the lesson will be B(second)
26
+
-`section` - the title of the section that the article is in. Only the first lesson for each section will be used.
27
+
-`description` - a one-to-three sentence summary of the lesson. used for the meta tag for social shares and SEO. if no description is given, the siteMetadata.description for the site is used.
28
+
-`icon` the Font Awesome icon you want for the home page of the site
29
+
19
30
## Lesson
20
31
21
-
The crux of this site is are the `lesson`. Provided are two examples. Each lesson needs a frontmattter path, order, and title. Generally you should make the path and the file name match for ease of finding it.
32
+
The crux of this site is are the `lesson`. Provided are two examples. Each lesson needs a frontmatter path, order, and title. Generally you should make the path and the file name match for ease of finding it.
22
33
23
34
- In `Lesson` directory there are various sections. You can start contributing from there.
24
35
- Inside each of the sections `lesson` present in the form of markdown. If you wanted to add a new lesson make a new file with `.md` extension and add at the top it.
@@ -37,17 +48,6 @@ The crux of this site is are the `lesson`. Provided are two examples. Each lesso
37
48
- Modify this according to your contribution and go ahead
38
49
- For writing concepts, take a look at the other [lessons]('lesson/Learn-Programming-Language/operator.md') markdown and make sure it is written in a similar way.
39
50
40
-
## Terms
41
-
42
-
Here are some terms that we will use in this repo:
43
-
44
-
-`path` needs a leading slash. This will be slug of the lesson
45
-
-`title`- will be the title displayed on the `Table of Contents` and on the page itself
46
-
-`order`- the order of which the item should appear in the table of contents. should in `<Number><Capital-letter>` format where the number corresponds to the section itself and the letter corresponds to the order of the lesson inside the section, e.g. 3B means under the section 3 and the order of the lesson will be B(second)
47
-
-`section` - the title of the section that the article is in. Only the first lesson for each section will be used.
48
-
-`description` - a one-to-three sentence summary of the lesson. used for the meta tag for social shares and SEO. if no description is given, the siteMetadata.description for the site is used.
49
-
-`icon` the Font Awesome icon you want for the home page of the site
50
-
51
51
## Requesting A Lesson
52
52
53
53
for requesting a lesson simply raise a new issue in the `Issues` section.
0 commit comments