Skip to content

Commit 1a3c6f5

Browse files
authored
Merge branch 'GDSC-RCCIIT:main' into main
2 parents 31530f1 + cb0b633 commit 1a3c6f5

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Thank you for showing interest in our project. Any contribution you make means a lot to us and will be reflected in the contributors tab on our repostiroy.
44

5-
This document will give you a detailed overview over how to contribute to our project and have your Pull Request accepted. Please,make sure you have read through thisdocumentation and followed the correct steps before making your first Pull Request in our repository. If you fail to follow the steps mentioned here, it might lead to your Pull Request being declined.
5+
This document will give you a detailed overview over how to contribute to our project and have your Pull Request accepted. Please,make sure you have read through this documentation and followed the correct steps before making your first Pull Request in our repository. If you fail to follow the steps mentioned here, it might lead to your Pull Request being declined.
66

77

88
## New contributors guide

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,9 @@ You can open an issue with us for a bug, feature or a new script or start workin
5555

5656
## Things to keep in mind when contributing
5757

58-
If you are adding a script to the repository, please create a separate directory with the name of the script inside the `scripts` directory of this repository and work within it. Make sure your script comes with its very own `README.md` with proper documentation for the end user, if possible add screenshots of your script working in the `README.md` as well. In case you are uploading screenshots and/or other relevant images please create a separate `images` folder inside your script folder, this is where you will be keeping your images. Alternatively, you can also upload your images on platforms like [imgur](https://imgur.com/) and use the resulting link in your `README.md` file.
58+
59+
If you are adding a script to the respository, please create a separate directory with the name of the script inside the `scripts` directory of this repository and work within it. Make sure your script comes with its very own `README.md` with proper documentation for the end user, if possible add screenshots of your script working in the `README.md` as well. In case you are uploading screenshots and/or other relevant images please create a separate `images` folder inside your script folder, this is where you will be keeping your images. Alternatively, you can also upload your images on platforms like [imgur](https://imgur.com/) and use the resulting link in your `README.md` file.
60+
5961

6062
Once you are done working on your script edit this `README.md` file and add the relevant information regarding your script in the table below.
6163

scripts/NewsReader/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
---
1212

13-
- Just run the exe file it will feth data in JSON format from the website.
13+
- Just run the exe file it will fetch data in JSON format from the website.
1414
- Also you can manually run .py file using `python news_reader.py` in the project folder
1515

1616
---

0 commit comments

Comments
 (0)