Skip to content

Commit 499eb97

Browse files
authored
PR #8: Typos-and-Grammatical-errors
<FIX> Typos and Grammatical errors Merge pull request #8 from rover07/fix/Correct-typo-README.md
2 parents c85ebfb + 3ede6c6 commit 499eb97

File tree

3 files changed

+43
-43
lines changed

3 files changed

+43
-43
lines changed

CODE_OF_CONDUCT.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ diverse, inclusive, and healthy community.
1515
## Our Standards
1616

1717
Examples of behavior that contributes to a positive environment for our
18-
community include:
18+
community includes:
1919

2020
* Demonstrating empathy and kindness toward other people
2121
* Being respectful of differing opinions, viewpoints, and experiences
@@ -33,7 +33,7 @@ Examples of unacceptable behavior include:
3333
* Public or private harassment
3434
* Publishing others' private information, such as a physical or email
3535
address, without their explicit permission
36-
* Other conduct which could reasonably be considered inappropriate in a
36+
* Other conduct that could reasonably be considered inappropriate in a
3737
professional setting
3838

3939
## Enforcement Responsibilities
@@ -50,7 +50,7 @@ decisions when appropriate.
5050

5151
## Scope
5252

53-
This Code of Conduct applies within all community spaces, and also applies when
53+
This Code of Conduct applies within all community spaces and also applies when
5454
an individual is officially representing the community in public spaces.
5555
Examples of representing our community include using an official e-mail address,
5656
posting via an official social media account, or acting as an appointed

CONTRIBUTING.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Welcome to CONTRIBUTING.md
22

3-
Hey there, fellow Developer !!!... I happy see, hyped about make your *, probably,* first contribution to this open source repo. I heartily welcome you to your journey in open source contribution. I hope you have fun learning and teaching at the same time. For the **Notebook**, most of the contribution done will be related to the content writing like blogs, tip & trick, tech update, various documentation, etc.
3+
Hey there, fellow Developer !!!... I am happy to see and hyped about making your *, probably,* first contribution to this open-source repo. I heartily welcome you to your journey in open source contribution. I hope you have fun learning and teaching at the same time. For the **Notebook**, most of the contribution will be related to content writing like blogs, tips & tricks, tech updates, various documentation, etc.
44

55
## Setting up Environment
66

7-
Before you even start working on your content writing, make sure you've got the right environment installed to build the project locally... As this project based on Jekyll[^1] framework that is built upon `Ruby`. We need `Ruby`, `Bundler` and `jekyll` framework to build and test within local systems. The installation process is different from platform to platform, so make sure you following the instruction properly.
7+
Before you even start working on your content writing, make sure you've got the right environment installed to build the project locally. As this project is based on Jekyll[^1] framework that is built upon `Ruby`. We need `Ruby`, `Bundler`, and `jekyll` frameworks to build and test within local systems. The installation process is different from platform to platform, so make sure you follow the instructions properly.
88

99
### For Ubuntu:
1010

@@ -35,12 +35,12 @@ gem install jekyll bundler
3535
```
3636

3737
> [!IMPORTANT]
38-
> For Other Linux Distros, check the offical [Jekyll](https://jekyllrb.com/docs/installation/other-linux/ "visit offical jekyll page for other linux installation") webpage. Also make sure, you have installed `bundler` along with jekyll using the follow command:
38+
> For Other Linux Distros, check the offical [Jekyll](https://jekyllrb.com/docs/installation/other-linux/ "visit offical jekyll page for other linux installation") webpage. Also make sure, you have installed `bundler` along with jekyll using the following command:
3939
```bash
4040
gem install bundler
4141
```
4242

43-
- Use the following command to check whether the `bundler` and jekyll framework installed properly or not.
43+
- Use the following command to check whether the `bundler` and jekyll framework are installed properly or not.
4444
```bash
4545
bundle info --path jekyll-theme-chirpy
4646
```
@@ -51,17 +51,17 @@ bundle info --path jekyll-theme-chirpy
5151

5252
For Windows users, setting up the environment is a bit more involved:
5353

54-
- Start by downloading and installing the the `Ruby` using [RubyInstaller](https://rubyinstaller.org/downloads/ "Download RubyInstaller"), choose the the latest one with Devkit with default options.
54+
- Start by downloading and installing the `Ruby` using [RubyInstaller](https://rubyinstaller.org/downloads/ "Download RubyInstaller"), and choose the latest one with Devkit with default options.
5555

56-
- At the end of installation, You'll get CMD asking you to enter option between 1-3. Enter 3 as input, then you can enter 2 if you want to update `MYSYS2` but that's totally optional. After all the installation is done, press enter to close the CMD prompt.
56+
- At the end of the installation, You'll get CMD asking you to enter options between 1-3. Enter 3 as input, then you can enter 2 if you want to update `MYSYS2` but that's totally optional. After all the installation is done, press enter to close the CMD prompt.
5757

5858
<div align="center">
5959

6060
![prompt-img](assets/img/contribute-to-notebook/cmd-prompt-img.png)
6161

6262
</div>
6363

64-
- Open a new command prompt window from the start menu, Use the following command to check whether `Ruby` has properly installed and its `PATH`` has been set properly.
64+
- Open a new command prompt window from the start menu, Use the following command to check whether `Ruby` has been properly installed and its `PATH`` has been set properly.
6565
```powershell
6666
ruby -v
6767
```
@@ -71,7 +71,7 @@ ruby -v
7171
gem install jekyll bundler
7272
```
7373

74-
- Use the following command to check whether the `bundler` and jekyll framework installed properly or not.
74+
- Use the following command to check whether the `bundler` and jekyll framework are installed properly or not.
7575
```bash
7676
bundle info --path jekyll-theme-chirpy
7777
```
@@ -85,7 +85,7 @@ If you're on MacOS, follow these steps:
8585
> [!ALERT]
8686
> Ensure you have the [Homebrew](https://brew.sh/ "Install Homebrew") package manager installed. If you're facing any issues while setting up the project in MacOS, check out the [Trobleshooting post](https://github.com/Grow-with-Open-Source/Notebook/discussions/3#discussioncomment-7151280) within the [Help Request](https://github.com/Grow-with-Open-Source/Notebook/discussions/3 "Goto Help Request Discussion") discussion.
8787
88-
- Start by install `chruby` and `ruby-install` with Homebrew:
88+
- Start by installing `chruby` and `ruby-install` with Homebrew:
8989
```bash
9090
brew install chruby ruby-install xz
9191
```
@@ -114,7 +114,7 @@ ruby -v
114114
gem install bundler jekyll
115115
```
116116

117-
- Use the following command to check whether the `bundler` and jekyll framework installed properly or not.
117+
- Use the following command to check whether the `bundler` and jekyll framework are installed properly or not.
118118
```bash
119119
bundle info --path jekyll-theme-chirpy
120120
```
@@ -152,19 +152,19 @@ bundle exec jekyll s
152152
bundler exec jekyll s --incremental
153153
```
154154

155-
- If project build is successful, then you can view the project build that is hosted through your [localhost:4000/Notebook](http://127.0.0.1:4000/Notebook/). Well done, you have successfully setted up the project within your local system.
155+
- If the project build is successful, then you can view the project build that is hosted through your [localhost:4000/Notebook](http://127.0.0.1:4000/Notebook/). Well done, you have successfully set up the project within your local system.
156156

157157
## Getting Started with Contribution
158158

159-
Now that you setted up the environment required and started analyzing the project, you have to know a few things about the project structure and its configuration before you started working on you content writing.
159+
Now that you set up the environment required and started analyzing the project, you have to know a few things about the project structure and its configuration before you start working on your content writing.
160160

161161
### Instructions and Guidelines
162162

163-
- All of the content writing will be done in Markdown *(`.md`)* file format. So, Make yourself more comfortable Markdown sytnax through [Offical GitHub Documentation](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github "visit the offical GitHub Docs").
163+
- All of the content writing will be done in Markdown *(`.md`)* file format. So, Make yourself more comfortable with Markdown syntax through [Offical GitHub Documentation](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github "visit the offical GitHub Docs").
164164

165-
- Since this open source is based chripy[^2] theme jekyll[^1] project, You're not limited by Markdown only. You can do much more using simple Markdown that provides easy of writing while supporting limited HTML elements. Check out the Chirpy-based [post creation](https://chirpy.cotes.page/posts/write-a-new-post/) and [text and typography](https://chirpy.cotes.page/posts/text-and-typography/) posts to know more.
165+
- Since this open source is based chripy[^2] theme jekyll[^1] project, You're not limited by Markdown only. You can do much more using simple Markdown that provides easy writing while supporting limited HTML elements. Check out the Chirpy-based [post creation](https://chirpy.cotes.page/posts/write-a-new-post/) and [text and typography](https://chirpy.cotes.page/posts/text-and-typography/) posts to know more.
166166

167-
- You need to add you details to link the author details with the posts. You can add your author details to the **`_data/authors.yml`** file in the following format:
167+
- You need to add your details to link the author's details with the posts. You can add your author details to the **`_data/authors.yml`** file in the following format:
168168
```yaml
169169
# Make sure the key_value is unique and not to be a duplicate
170170
unique_key_value:
@@ -187,11 +187,11 @@ shamith_watchdogs:
187187
<div>
188188
</details>
189189
190-
- It is highly recommended to use the images though CDN links. But if for some reason you unable to do so, then store them in a new folder that is named after your post and save that folder within **`assets/img`** directory as **`assets/img/<your-project-name>/`**. Try avoid the process of *storing images within `assets/img` directory as it reflects the size of project.
190+
- It is highly recommended to use the images through CDN links. But if for some reason you are unable to do so, then store them in a new folder that is named after your post and save that folder within **`assets/img`** directory as **`assets/img/<your-project-name>/`**. Try avoid the process of *storing images within `assets/img` directory as it reflects the size of the project.
191191

192192
- Place your content writing files within the **`_posts`** directory, following the naming convention **`YYYY-MM-DD-file-name.md`**, e.g., `2023-09-27-welcome-to-notebook.md`. **Use lowercase letters and separate words with a single dash.**
193193

194-
- Each and every content writing files should contain the following meta-data *(or)* configuration for the project to be successfully build:
194+
- Each and every content writing file should contain the following meta-data *(or)* configuration for the project to be successfully built:
195195
```md
196196
---
197197
title: <title>
@@ -231,22 +231,22 @@ image:
231231

232232
> [!IMPORTANT]
233233
> - Note that the `+/-TTTT` in the `date` section refers the **UTC offset**. You can find your **UTC offset** value by searching for your country in the [list of UTC](https://en.wikipedia.org/wiki/List_of_UTC_offsets "Goto List of UTC offsets"). And if you're from India, you can use the above UTC offset from the example.
234-
> - If there are more that one person/author working on a single post, then use `authors` attribute instread of `author`. Also the input for the `authors` attribute will be a list of unique_key_value represnting the authors.
234+
> - If there is more than one person/author working on a single post, then use `authors` attribute instead of `author`. Also, the input for the `authors` attribute will be a list of unique_key_value representing the authors.
235235
> - It's complete optional to have `img_path` and `image` attribute. Use them if and only if, your post requires any images.
236236
> - If your post is using images and you have set the `img_path`, then you can directly access the images just by using their name.
237237
> - The `image` attribute will act as the page cover or thumbnail for your post. It's up to you to add a page-cover or not.
238238

239-
These are the important instruction and guidelines you need follow for creating a successful post without any issue.
239+
These are important instructions and guidelines you need to follow to create a successful post without any issues.
240240

241241
### Contributing
242242

243-
Now that you have basic understanding about the working of the project, let's talk a bit about process of contributing...
243+
Now that you have a basic understanding of the workings of the project, let's talk a bit about the process of contributing...
244244

245245
**Step 1:** You start you setting up the environment [*(as discussed above)*](#setting-up-environment).
246246

247247
**Step 2:** After setting up the required environment, now build the project locally [*(as discussed above)*](#build-the-project-locally).
248248

249-
**Step 3:** Create a new branch to work on you contribution. use the following command:
249+
**Step 3:** Create a new branch to work on your contribution. use the following command:
250250
```bash
251251
# create and check out to new branch
252252
git checkout -b <simple-relavent-branch-name>
@@ -255,11 +255,11 @@ git checkout -b <simple-relavent-branch-name>
255255
git branch
256256
```
257257

258-
**Step 4:** Now that you got the project up and running within you local machine, start by adding your details as author to [`_data/authors.yml`](_data/authors.yml) file as [mention above](#instructions-and-guidelines). Make sure you author key is unique and different from others.
258+
**Step 4:** Now that you got the project up and running within your local machine, start by adding your details as an author to [`_data/authors.yml`](_data/authors.yml) file as [mention above](#instructions-and-guidelines). Make sure your author key is unique and different from others.
259259

260-
**Step 5:** Now go ahead and create a new markdown file to work on post to contribute. Make sure you follow the naming convension for the file which is `YYYY-MM-DD-your-post-name`. And you post name should be all small alphanumeric separated by dashs *(-)*.
260+
**Step 5:** Now go ahead and create a new markdown file to work on post to contribute. Make sure you follow the naming convention for the file which is `YYYY-MM-DD-your-post-name`. And you post name should be all small alphanumeric separated by dashs *(-)*.
261261

262-
**Step 6:** Make sure you commit every change it now, one commit for adding the author name and one for creating a new markdown file. Using the following command:
262+
**Step 6:** Make sure you commit every change now, one commit for adding the author name and one for creating a new markdown file. Using the following command:
263263
```bash
264264
# Adding or staging the changes
265265
git add .
@@ -271,15 +271,15 @@ git commit -m "<related-short-message>
271271
> [!IMPORTANT]
272272
> Make sure to commit your each and every change with proper description
273273

274-
- **Step 7:** After creating the empty mark down file, add the required meta data *(or)* configuration as [mention above](#instructions-and-guidelines).
274+
- **Step 7:** After creating the empty markdown file, add the required metadata *(or)* configuration as [mention above](#instructions-and-guidelines).
275275

276276
- **Step 8:** Now, proceed with your content writing using markdown syntax and also using additional features of Chirpy theme[^2].
277277

278-
- **Step 9:** If you have any images, try adding CDN links to the source containing all the images. If not, you can create a new directory using you posts name *(separated with dashes -)* within the `assets/img/` as `assets/img/<your-post-name>`. And also mention the CDN or directory path in `img_path` attribute as [mention above](#instructions-and-guidelines).
278+
- **Step 9:** If you have any images, try adding CDN links to the source containing all the images. If not, you can create a new directory using your posts name *(separated with dashes -)* within the `assets/img/` as `assets/img/<your-post-name>`. And also mention the CDN or directory path in `img_path` attribute as [mention above](#instructions-and-guidelines).
279279

280-
- **Step 10 (optional):** After you done with you post *(don't forget to come each and every change)*, if you want you can add an page-cover (or) thumbnail to you post. Just mention the image name within the sub attribute `path` of the main attribute `image`.
280+
- **Step 10 (optional):** After you are done with your post *(don't forget to come with each and every change)*, if you want you can add a page-cover (or) thumbnail to your post. Just mention the image name within the sub-attribute `path` of the main attribute `image`.
281281

282-
- **Step 11:** After commit all the changes and completion of your work. push your commit to you forked repo, using the following commands:
282+
- **Step 11:** After committing all the changes and completion of your work. push your commit to your forked repo, using the following commands:
283283
```bash
284284
# check your branch name
285285
git branch
@@ -290,20 +290,20 @@ git push origin <your-branch-name>
290290

291291
- **Step 12:** Now, create a pull request to the [original repo](https://github.com/Grow-with-Open-Source/Notebook). [Learn about Pull requests](https://docs.github.com/articles/using-pull-requests "offical GitHub documentaiton")
292292

293-
And that it, you have done it !!!... Now, it's time for the maintainer to review you work and merge you pull request. If there's any issue with your pull request, then the maintainer will contact you and asks for a few changes. And he merges your Pull request, you have successfully did your first open source contribution that actual help others.
293+
And that is it, you have done it !!!... Now, it's time for the maintainer to review your work and merge your pull request. If there's any issue with your pull request, then the maintainer will contact you and ask for a few changes. And he merges your Pull request, you have successfully made your first open-source contribution that actually helps others.
294294

295-
Everybody can see you work and make use of it. Good job, mate !!...
295+
Everybody can see your work and make use of it. Good job, mate !!...
296296

297297
## Rules and Regulations
298298

299299
Here are some ground rules that you need to follow:
300300

301-
- It's important for you to commit each and every change. Don't just finish all of your work with a single commit. If you're a newbie, it will only be tolerated for 3 times.
302-
- Sending several pull request for a single post is not accepted.
303-
- Your Pull Request will not be merged, if you have modified, changed or deleted any files or content that doesn't belong to you.
304-
- Pull Request containing any illegal, NFSW or any other content which doesn't help other in anyway possible will be close immediately.
305-
- The Pull Request will only be merged if you everything seem to be in order. You be notified if you did something wrong, and you pull request will only be merged if the notified changes are made.
301+
- It's important for you to commit to each and every change. Don't just finish all of your work with a single commit. If you're a newbie, it will only be tolerated 3 times.
302+
- Sending several pull requests for a single post is not accepted.
303+
- Your Pull Request will not be merged, if you have modified, changed, or deleted any files or content that doesn't belong to you.
304+
- Pull Request containing any illegal, NFSW or any other content which doesn't help others in any way possible will be closed immediately.
305+
- The Pull Request will only be merged if everything seems to be in order. You be notified if you did something wrong, and your pull request will only be merged if the notified changes are made.
306306

307307

308-
[^1]: **GitHub's Jekyll Framework offical Page:** <https://jekyllrb.com>
309-
[^2]: **Chirpy Jekyll theme's Offical Repo:** <https://github.com/cotes2020/jekyll-theme-chirpy>
308+
[^1]: **GitHub's Jekyll Framework official Page:** <https://jekyllrb.com>
309+
[^2]: **Chirpy Jekyll theme's Offical Repo:** <https://github.com/cotes2020/jekyll-theme-chirpy>

0 commit comments

Comments
 (0)