Skip to content
This repository was archived by the owner on Dec 22, 2023. It is now read-only.

Commit b0f51c3

Browse files
authored
Update README.md
1 parent 39d651f commit b0f51c3

File tree

1 file changed

+53
-5
lines changed

1 file changed

+53
-5
lines changed

README.md

+53-5
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,12 @@
1414

1515
Scripts in python that scrape the web, create a bot or use an API to solve a problem.
1616

17-
## How to Contribute?
17+
## Steps To Follow
1818

19-
- Claim an existing issue or create one [here](https://github.com/AdityaJ7/Python_and_the_Web/issues/new)'
20-
- Found a bug in some script report it [here]()
21-
- Check existing scripts [project here.](https://github.com/AdityaJ7/Python_and_the_Web/tree/master/Scripts)
19+
- Select an issue and ask to be *assigned* to it.
20+
- Check existing scripts [project here.](https://github.com/AdityaJ7/Python_and_the_Web/tree/master/projects)
2221
- **Star** the repository.
23-
- On the [GitHub page for this repository](https://github.com/AdityaJ7/Python_and_the_Web/Scripts), click on the Button "**Fork**".
22+
- On the [GitHub page for this repository](https://github.com/AdityaJ7/Python_and_the_Web), click on the Button "**Fork**".
2423
![fork image](https://help.github.com/assets/images/help/repository/fork_button.jpg)
2524
- Create clone ***your forked repository*** on your local machine.
2625
![code ui](https://docs.github.com/assets/images/help/repository/code-button.png)
@@ -32,3 +31,52 @@ Scripts in python that scrape the web, create a bot or use an API to solve a pro
3231
```
3332

3433
**Replace \<your-github-username\>!**
34+
35+
Learn more about [forking](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) and [cloning a repo](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository).
36+
- Before you make any changes, [keep your fork in sync](https://www.freecodecamp.org/news/how-to-sync-your-fork-with-the-original-git-repository/) to avoid merge conflicts:
37+
38+
```bash
39+
git remote add upstream https://github.com/chavarera/python-mini-projects.git
40+
git fetch upstream
41+
git pull upstream master
42+
git push
43+
```
44+
45+
- If you run into a **merge conflict**, you have to resolve the conflict. There are a lot of guides online, or you can try this one by [opensource.com](https://opensource.com/article/20/4/git-merge-conflict).
46+
47+
- Checkout to development branch (*name your branch according to the issue name*).
48+
49+
```basg
50+
git checkout -b <branch-name>
51+
```
52+
53+
- Create a folder in [projects directory](https://github.com/chavarera/python-mini-projects/tree/master/projects) according to issue name.
54+
- Write your code and add to the respective folder in the projects directory, locally.
55+
- Don't forget to add a `README.md` in your folder, according to the [README_TEMPLATE.](https://github.com/chavarera/python-mini-projects/blob/master/README_TEMPLATE.md)
56+
- Add the changes with `git add`, `git commit` ([write a good commit message](https://chris.beams.io/posts/git-commit/), if possible):
57+
58+
```bash
59+
git add -A
60+
git commit -m "<your message>"
61+
```
62+
63+
- Push the code *to your repository*.
64+
65+
```bash
66+
git push origin <branch-name>
67+
```
68+
69+
- Go to the GitHub page of _your fork_, and **make a pull request**:
70+
71+
![pull request image](https://help.github.com/assets/images/help/pull_requests/choose-base-and-compare-branches.png)
72+
73+
Read more about pull requests on the [GitHub help pages](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
74+
- Now wait, until one of us *reviews your Pull Request*! If there are any conflicts, you will get a notification.
75+
76+
## README Template for scripts
77+
78+
[README Template](https://github.com/AdityaJ/Python_and_the_Web/blob/master/README_TEMPLATE.md)
79+
80+
## Connect On Social media
81+
82+
[Join WhatsApp group](https://chat.whatsapp.com/Ghp25kidWLaGrAVA0G0GAa)

0 commit comments

Comments
 (0)