Skip to content

Commit 0326d8b

Browse files
committed
Corrected typos in 46 files. Squashed 7 Commit
There were errors in CONTRIBUTING.md and a few READM files. I coorected them. Moreover i updated my accepdted contribution in Python->README.md
1 parent 1d45873 commit 0326d8b

File tree

46 files changed

+175
-157
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+175
-157
lines changed

Bash/JSON_Parse_with_jq/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### json parsing in bash
22

3-
`find_flag.sh` sctipt will tell you how to use [jq](https://stedolan.github.io/jq/) command to parse JSON file in bash with an example (`sample.json`)
3+
`find_flag.sh` script will tell you how to use [jq](https://stedolan.github.io/jq/) command to parse JSON file in bash with an example (`sample.json`)
44

55
The script will run below 3 commands and find the flag from the `sample.json` file
66

CONTRIBUTING.md

Lines changed: 79 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,83 @@
1-
# Contributing Guidelines
2-
3-
This documentation contains a set ofguidelines to help you during the contribution process.
4-
We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, **no contribution is too small.**
5-
6-
# Submitting Contributions👩‍💻👨‍💻
7-
Below you will find the process and workflow used to review and merge your changes.
8-
## Step 0 : Find an issue
9-
- Take a look at the Existing Issues or create your **own** Issues!
10-
- Wait for the Issue to be assigned to you after which you can start working on it.
11-
- Note : Every change in this project should/must have an associated issue.
12-
![script](https://user-images.githubusercontent.com/44089458/86088644-5d4e7280-bac4-11ea-951d-18965e11877b.jpg)
13-
14-
## Step 1 : Fork the Project
15-
- Fork this Repository. This will create a Local Copy of this Repository on your Github Profile. Keep a reference to the original project in `upstream` remote.
16-
```
17-
$ git clone https://github.com/<your-username>/<repo-name>
18-
$ cd <repo-name>
19-
$ git remote add upstream https://github.com/<upstream-owner>/<repo-name>
20-
```
21-
![script1](https://user-images.githubusercontent.com/44089458/86088965-ebc2f400-bac4-11ea-80d3-80d5e52e4353.jpg)
22-
23-
- If you have already forked the project, update your copy before working.
24-
```
25-
$ git remote update
26-
$ git checkout <branch-name>
27-
$ git rebase upstream/<branch-name>
28-
```
29-
## Step 2 : Branch
30-
Create a new branch. Use its name to identify the issue your addressing.
31-
```
1+
# Contributing Guidelines
2+
3+
This documentation contains a set of guidelines to help you during the contribution process.
4+
We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, **no contribution is too small.**
5+
6+
# Submitting Contributions👩‍💻👨‍💻
7+
Below you will find the process and workflow used to review and merge your changes.
8+
## Step 0 : Find an issue
9+
- Take a look at the Existing Issues or create your **own** Issues!
10+
- Wait for the Issue to be assigned to you after which you can start working on it.
11+
- Note : Every change in this project should/must have an associated issue.
12+
![script](https://user-images.githubusercontent.com/44089458/86088644-5d4e7280-bac4-11ea-951d-18965e11877b.jpg)
13+
14+
## Step 1 : Fork the Project
15+
- Fork this Repository. This will create a Local Copy of this Repository on your Github Profile. Keep a reference to the original project in `upstream` remote.
16+
```
17+
$ git clone https://github.com/<your-username>/<repo-name>
18+
$ cd <repo-name>
19+
$ git remote add upstream https://github.com/<upstream-owner>/<repo-name>
20+
```
21+
![script1](https://user-images.githubusercontent.com/44089458/86088965-ebc2f400-bac4-11ea-80d3-80d5e52e4353.jpg)
22+
23+
- If you have already forked the project, update your copy before working.
24+
```
25+
$ git remote update
26+
$ git checkout <branch-name>
27+
$ git rebase upstream/<branch-name>
28+
```
29+
## Step 2 : Branch
30+
Create a new branch. Use its name to identify the issue your addressing.
31+
```
3232
# It will create a new branch with name Branch_Name and switch to that branch
33-
$ git checkout -b branch_name
34-
```
35-
## Step 3 : Work on the issue assigned
36-
- Work on the issue(s) assigned to you.
37-
- Add all the files/folders needed.
38-
- After you've made changes or made your contribution to the project add changes to the branch you've just created by:
39-
```
40-
# To add all new files to branch Branch_Name
41-
$ git add .
42-
```
43-
## Step 4 : Commit
44-
- To commit give a descriptive message for the convenience of reveiwer by:
45-
```
46-
# This message get associated with all files you have changed
47-
$ git commit -m 'message
48-
```
49-
- **NOTE**: A PR should have only one commit. Multiple commits should be squashed.
50-
## Step 5 : Work Remotely
51-
- Now you are ready to your work to the remote repository.
52-
- When your work is ready and complies with the project conventions, upload your changes to your fork:
33+
$ git checkout -b branch_name
34+
```
35+
## Step 3 : Work on the issue assigned
36+
- Work on the issue(s) assigned to you.
37+
- Add all the files/folders needed.
38+
- After you've made changes or made your contribution to the project add changes to the branch you've just created by:
39+
```
40+
# To add all new files to branch Branch_Name
41+
$ git add .
5342
43+
# To add only a few files to Branch_Name
44+
$ git add <some files>
5445
```
55-
# To push your work to your remote repository
56-
$ git push -u origin Branch_Name
46+
47+
## Step 4 : Commit
48+
- To commit give a descriptive message for the convenience of reviewer by:
5749
```
58-
- Here is how your branch will look.
59-
![br](https://user-images.githubusercontent.com/44089458/86090718-3d20b280-bac8-11ea-971d-15be55cfe259.jpg)
60-
61-
## Step 6 : Pull Request
62-
- Go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your contribution.
63-
<img width="677" alt="pr" src="https://user-images.githubusercontent.com/44089458/86090744-4b6ece80-bac8-11ea-9d69-a0098e9d4874.PNG">
64-
65-
<img width="882" alt="pullr" src="https://user-images.githubusercontent.com/44089458/86092345-fed8c280-baca-11ea-9a04-95991d9c60d2.PNG">
66-
- Voila! Your Pull Request has been submitted and will be reviewed by the moderators and merged.🥳
67-
68-
## Need more help?🤔
69-
You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:
70-
- [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
71-
- [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request)
72-
- [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github)
73-
- [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6)
74-
- [Learn GitHub from Scratch](https://lab.github.com/githubtraining/introduction-to-github)
75-
76-
77-
## Tip from us😇
78-
It always takes time to understand and learn. So, do not worry at all. We know **you have got this**!💪
50+
# This message get associated with all files you have changed
51+
$ git commit -m "message"
52+
```
53+
- **NOTE**: A PR should have only one commit. Multiple commits should be squashed.
54+
55+
## Step 5 : Work Remotely
56+
- Now you are ready to your work to the remote repository.
57+
- When your work is ready and complies with the project conventions, upload your changes to your fork:
58+
59+
```
60+
# To push your work to your remote repository
61+
$ git push -u origin Branch_Name
62+
```
63+
- Here is how your branch will look.
64+
![br](https://user-images.githubusercontent.com/44089458/86090718-3d20b280-bac8-11ea-971d-15be55cfe259.jpg)
65+
66+
## Step 6 : Pull Request
67+
- Go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your contribution.
68+
<img width="677" alt="pr" src="https://user-images.githubusercontent.com/44089458/86090744-4b6ece80-bac8-11ea-9d69-a0098e9d4874.PNG">
69+
70+
<img width="882" alt="pullr" src="https://user-images.githubusercontent.com/44089458/86092345-fed8c280-baca-11ea-9a04-95991d9c60d2.PNG">
71+
- Voila! Your Pull Request has been submitted and will be reviewed by the moderators and merged.🥳
72+
73+
## Need more help?🤔
74+
You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:
75+
- [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
76+
- [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request)
77+
- [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github)
78+
- [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6)
79+
- [Learn GitHub from Scratch](https://lab.github.com/githubtraining/introduction-to-github)
80+
81+
82+
## Tip from us😇
83+
It always takes time to understand and learn. So, do not worry at all. We know **you have got this**!💪

Go/GIF_Creator/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Video/Images to GIF conerter in golang
1+
# Video/Images to GIF converter in golang
22

33
## Use [ffmpeg](https://ffmpeg.org/) before using script
44

Python/Audio_Converter/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This Automation Script is used to convert the any type of video file into audio
55
### Setup
66

77
1. Create a Virtual Environment.
8-
2. Install the requiremnts by using `pip3 install -r requiremnts.txt`
8+
2. Install the requirements by using `pip3 install -r requiremnts.txt`
99
3. Hurray.! You're ready to use the script to convert video to audio.
1010

1111
### Running a file

Python/Automate_Commiting_Using_Git/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![image](https://steadylearner.com/static/images/post/Python/python-github-by-Steadylearner.png)
44

5-
Are you tired of adding, commiting and pushing you code everytime you change it? If so, you can use this Python script to automate this boring stuff.
5+
Are you tired of adding, committing and pushing you code everytime you change it? If so, you can use this Python script to automate this boring stuff.
66
This code is the simplest one to automate the task.
77

88
## Understanding the code
@@ -25,7 +25,7 @@ _subprocess.getoutput:_ Return output (stdout and stderr) of executing cmd in a
2525
message = input("Enter commit message")
2626
```
2727

28-
Now, you can simply understand that we'e taking an input message to give it to the commit message in the next command.
28+
Now, you can simply understand that we are taking an input message to give it to the commit message in the next command.
2929

3030
```
3131
subprocess.getoutput('git commit -m ' + message)
@@ -44,4 +44,4 @@ subprocess.getoutput('git push origin ' + branchname)
4444
```
4545

4646
Finally, to push our code we are using, `git push origin <branch-name>`.
47-
You can also add a variable to the remoteurl for defining the origin, but by default it is origin.
47+
You can also add a variable to the remote url for defining the origin, but by default it is origin.

Python/Battery_Full_Charged_Notifier/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22

33
As a laptop user you must take caution about your battery because the battery is also the most important component
44
If you are using an old laptop then you might be a wonder to protect your battery from getting overcharged!
5-
This Python script helps you to get a notification, when your laptop get 100% charged. This script can run in background or you can paste it in starup folder so that everytime you open your laptop, this script starts running automatically
5+
This Python script helps you to get a notification, when your laptop get 100% charged. This script can run in background
6+
or you can paste it in startup folder so that everytime you open your laptop, this script starts running automatically
67

7-
**In this code I have also made script to notify you when battery is 90% charged and plugged, you can remove it, if you don't want that part**
8+
**In this code I have also made script to notify you when battery is 90% charged and plugged, you can remove it, if you
9+
don't want that part**
810

911
## To run the code
1012

@@ -17,12 +19,13 @@ This Python script helps you to get a notification, when your laptop get 100% ch
1719
- Also check for any package that's need to be installed, on cmd
1820
- then run by typing **python python battery_full_charged_notifier.pyw**
1921

20-
**Note after running successfully for first time, you can then run by just double clicing on the script, like to run as a program**
22+
**Note after running successfully for first time, you can then run by just double clicking on the script, like to run as
23+
a program**
2124

2225
## Explanation of code
2326

2427
- We have used python libraries like psutil to get information about the system, this is the package that gives information about battery.
25-
- Also we are using pyttsx3 module to give a sound notifiaction regarding the battery along with the popup notification
28+
- Also we are using pyttsx3 module to give a sound notification regarding the battery along with the popup notification
2629
- win10toast is used to create the notification, that is what you see normally in our Pc's
2730

2831
## Output

Python/Bulk_Certificate_Generator/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ This Script is used to generate large number of certificates in a short period o
55
### Setup
66

77
1. Create a Virtual Environment.
8-
2. Install the requiremnts by using `pip3 install -r requiremnts.txt`
8+
2. Install the requirements by using `pip3 install -r requiremnts.txt`
99
3. Hurray.! You're ready to use the Script.
1010

1111
### Prerequisites
1212

1313
1. You need to develop your own template on your favourite design tool like figma, Adobe Xd, Sketch etc. and place your certificate template in the certificate template folder.
1414
2. Once the template is ready, Please calculate the coordinates using the design tool for writing the candidate name and certificate Id.
15-
3. If you want to change the fonts download the font files in .tff format and place it inside the fonst folder.
15+
3. If you want to change the fonts download the font files in .tff format and place it inside the `fonts` folder.
1616
4. Change the fonts on the script with your new fonts the Boom.! The script will automatically generate the certificates.
1717
5. Place your names excel file in the data folder.
1818

@@ -32,4 +32,4 @@ This Script is used to generate large number of certificates in a short period o
3232

3333
### Note
3434

35-
You need to change the some setting according to your template requirement. But it work absolutely fine if you follow the above th guidelines properly.
35+
You need to change the some setting according to your template requirement. But it work absolutely fine if you follow the above the guidelines properly.

Python/CRICBUZZ scraper/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Cricbuzz srapper
22

3-
This python script will scrap cricbuzz.com to get live scores.
3+
This python script will scrap [cricbuzz](www.cricbuzz.com) to get live scores.
44

55
## Technologies used:
66
- urllib.request

Python/Codechef_Problem_Scrapper/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ You will need the following things to be able to use it:
88

99
1.Chrome Browser
1010

11-
2.Chromedriver accroding to the version of your chrome browser.Put this in the same directory as your script.
11+
2.Chromedriver according to the version of your chrome browser.Put this in the same directory as your script.
1212

1313
3.Some external python libraries which you can get by running the following command:
1414

15-
pip install -r requirements.txt
15+
`pip install -r requirements.txt`
1616

1717
4.And yes, a stable internet connection too.
1818

1919
After fulfilling the above necessities run the following command:
2020

21-
python codechef_problem_solver.py
21+
`python3 codechef_problem_solver.py`
2222

2323
It will request a problem code from you.
2424

Python/Email_Scrape_From_Webpage/webpage-email-scrape.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
# Importing required libraries and modules.
44
import re # For regular expression operations
55
import requests # For sending HTTP request to server
6-
from urllib.parse import urlsplit # For Spliting the URL
6+
from urllib.parse import urlsplit # For Splitting the URL
77
from collections import deque # A list-like container
88
from bs4 import BeautifulSoup # A Python package for parsing HTML and XML documents
9-
import requests.exceptions # For handling eceptions
9+
import requests.exceptions # For handling exceptions
1010

1111
# Enter here the webpage to scrape in the original_url.
1212
original_url = input("Enter the webpage url: ")
@@ -20,7 +20,7 @@
2020
# a set of fetched emails to save fetched emails
2121
emails = set()
2222

23-
# moving unsraped_url from the queue to scraped_urls set
23+
# moving unscraped_url from the queue to scraped_urls set
2424
url = unprocessed_urls.popleft()
2525
# Remove and return an element from the left side of the deque.
2626
processed_urls.add(url)

0 commit comments

Comments
 (0)