@@ -5,6 +5,7 @@ and refer to it throughout the development of your contribution.
55
661 . [ General Guidelines] ( #general-guidelines )
772 . [ Commit Message Guidelines] ( #commit-message-guidelines )
8+ 3 . [ Markdown Guidelines] ( #markdown-guidelines )
89
910
1011## General Guidelines
@@ -53,6 +54,7 @@ class ExampleClass:
5354```
5455
5556
57+
5658## Commit Message Guidelines
5759When committing, commit messages are prefixed with a ` + ` or ` - ` . Depending on the type of change made
5860influences which prefix is used.
@@ -67,4 +69,40 @@ Commit messages are also to begin with an uppercase character. Below list some e
6769git commit -m "+ Added README.md"
6870git commit -m "- Removed README.md"
6971git commit -m "Moved README.md"
70- ```
72+ ```
73+
74+
75+
76+ ## Markdown Guidelines
77+ Currently, documentation for this project resides in markdown files.
78+ - Headings are to be separated with 3 lines
79+ - Use of HTML comments is appreciated
80+ - Use of HTML is permitted
81+ - [ reference style links] ( https://www.markdownguide.org/basic-syntax/#reference-style-links ) are not required by are appreciated
82+ - Exceedingly long lines are to be broken
83+ - The indents are to be two spaces
84+
85+ ``` markdown
86+ <!-- example markdown document-->
87+ # Section
88+ Lorem ipsum dolor sit amet, consectetur adipiscing elit,
89+ sed do eiusmod tempor incididunt ut labore et dolore
90+ magna aliqua. Ut enim ad minim veniam, quis nostrud
91+ exercitation ullamco laboris nisi ut aliquip ex ea
92+ commodo consequat. Duis aute irure dolor in
93+ reprehenderit in voluptate velit esse cillum dolore eu
94+ fugiat nulla pariatur. Excepteur sint occaecat cupidatat
95+ non proident, sunt in culpa qui officia deserunt mollit
96+ anim id est laborum. found [ Lorem Ipsum Generator]
97+
98+
99+
100+ # Section 2
101+ <ul >
102+ <li > Apple
103+ <li > Orange
104+ <li > Pineapple
105+ </ul >
106+
107+ [ Lorem Ipsum Generator ] : https://loremipsum.io/generator/
108+ ```
0 commit comments