Skip to content

Commit 2ad74a8

Browse files
committed
add grammarly to list of formatting conventions
1 parent 194934d commit 2ad74a8

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,27 +31,28 @@ This serves as a content monorepo for all the readings of the backend bootcamp c
3131
└───... // and so on
3232
```
3333

34-
## Folder naming Conventions
34+
## Folder Naming Conventions
3535

3636
- 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`.
3737
- 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`.
3838

39-
## Reading format
39+
## Reading Format
4040

4141
- Each reading should begin with the title as an h1.
4242
- Below the title it should have the summary and learning goals.
4343
- After this goes in the main content of the reading.
4444
- Finally each reading should conclude with a section called Resources, where we can link the external blogs/tutorials/videos we referred to.
4545

46-
## General formatting Conventions
46+
## General Formatting Conventions
4747

4848
- Use proper header hierarchy (h1 # to h6 ######) to convey the flow of topics and sub-topics.
4949
- Use code and syntax highlighting for code blocks and referring variable/function names.
5050
- Use tables and lists for non-code content blocks.
5151
- 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.
5253

5354

54-
## Peer review process
55+
## Peer Review Process
5556
- Work on a module or reading on it's own branch and open a PR into main branch.
5657
- Request at least 2 reviewers on your PRs.
5758
- 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

Comments
 (0)