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: README.md
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,27 +31,28 @@ This serves as a content monorepo for all the readings of the backend bootcamp c
31
31
└───... // and so on
32
32
```
33
33
34
-
## Folder naming Conventions
34
+
## Folder Naming Conventions
35
35
36
36
- For every new reading, name the folder as: `r[number]-name-of-reading`. For example, `r1-introduction-to-backend` or `r2.1-relational-database-structure`.
37
37
- Use your discretion to shorten certain folder names if required while maintaining the same meaning. For example, the folder for "Beginners guide to Node.js and NPM" can be named as `r1.1-beginners-guide-nodejs-npm`.
38
38
39
-
## Reading format
39
+
## Reading Format
40
40
41
41
- Each reading should begin with the title as an h1.
42
42
- Below the title it should have the summary and learning goals.
43
43
- After this goes in the main content of the reading.
44
44
- Finally each reading should conclude with a section called Resources, where we can link the external blogs/tutorials/videos we referred to.
45
45
46
-
## General formatting Conventions
46
+
## General Formatting Conventions
47
47
48
48
- Use proper header hierarchy (h1 # to h6 ######) to convey the flow of topics and sub-topics.
49
49
- Use code and syntax highlighting for code blocks and referring variable/function names.
50
50
- Use tables and lists for non-code content blocks.
51
51
- Always share links through inline links. For example, check out [this markdown cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) is preferred over check out this markdown cheatsheet: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
52
+
- Make sure to run your content through [Grammarly](https://www.grammarly.com/) to get rid of typos and grammatical errors.
52
53
53
54
54
-
## Peer review process
55
+
## Peer Review Process
55
56
- Work on a module or reading on it's own branch and open a PR into main branch.
56
57
- Request at least 2 reviewers on your PRs.
57
58
- Open draft PRs early for large modules to get continuous peer reviews. This helps your peers know that the PR is still WIP and is also helpful to review the content in chunks.
0 commit comments