Skip to content
This repository was archived by the owner on May 25, 2022. It is now read-only.

Commit a00fba4

Browse files
committed
Update and describe README for beginners.
1 parent b05a292 commit a00fba4

File tree

2 files changed

+55
-18
lines changed

2 files changed

+55
-18
lines changed

README.md

Lines changed: 53 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
![Issues](https://img.shields.io/github/issues/chavarera/python-mini-projects)
66
![Pull Requests](https://img.shields.io/github/issues-pr/chavarera/python-mini-projects?)
77
![Forks](https://img.shields.io/github/forks/chavarera/python-mini-projects)
8-
![Stars]( https://img.shields.io/github/stars/chavarera/python-mini-projects)
8+
![Stars](https://img.shields.io/github/stars/chavarera/python-mini-projects)
99
![License](https://img.shields.io/github/license/chavarera/python-mini-projects)
1010

1111
[![forthebadge](https://forthebadge.com/images/badges/built-by-developers.svg)](https://forthebadge.com)
@@ -15,31 +15,68 @@
1515

1616
# Mini-Projects-Python
1717

18-
A collection of simple python mini projects to enhance your python skills
18+
A collection of simple python mini projects to enhance your Python skills.
1919

20-
If you want to learn about python visit [Here](https://github.com/chavarera/PythonScript)
20+
If you want to learn about python, visit [here.](https://github.com/chavarera/PythonScript)
2121

22-
If you are new to Github and open source then visit [Here](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6)
22+
If you are new to Github and open source then, visit [here.](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6)
2323

2424
## Steps To Follow
2525

26-
- Select an issue and ask to be assigned to it.
27-
- Check existing scripts [project here](https://github.com/AdityaJ7/python-mini-projects/tree/master/projects)
28-
- Star the repository.
29-
- Create a fork of the project(repository).
30-
- Create clone of forked project on your local machine.
31-
- Checkout to development branch(Name your branch according to the issue name).
32-
- Create a folder in projects directory according to issue name.
33-
- Write your code.
34-
- Commit the changes.
35-
- Push the code.
36-
- Create a pull request.
26+
- Select an issue and ask to be *assigned* to it.
27+
- Check existing scripts [project here.](https://github.com/AdityaJ7/python-mini-projects/tree/master/projects)
28+
- **Star** the repository.
29+
- On the [GitHub page for this repository](https://github.com/chavarera/python-mini-projects), click on the Button "**Fork**".
30+
![fork image](https://help.github.com/assets/images/help/repository/fork_button.jpg)
31+
- Create clone *your forked repository* on your local machine.
32+
![code ui](https://docs.github.com/assets/images/help/repository/code-button.png)
33+
34+
For example, run this command inside your terminal:
35+
36+
```bash
37+
git clone https://github.com/<your-github-username>/python-mini-projects.git
38+
```
39+
40+
**Replace \<your-github-username\>!**
41+
42+
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).
43+
- 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:
44+
45+
```bash
46+
git remote add upstream https://github.com/chavarera/python-mini-projects.git
47+
git fetch upstream
48+
git pull upstream master
49+
git push
50+
```
51+
- 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).
52+
- Checkout to development branch (Name your branch according to the issue name).
53+
```git checkout -b <branch-name>
54+
```
55+
- Create a folder in [projects directory](https://github.com/chavarera/python-mini-projects/tree/master/projects) according to issue name.
56+
- Write your code and add to the respective folder in the projects directory, locally.
57+
- Add the changes with `git add`, `git commit` ([write a good commit message](https://chris.beams.io/posts/git-commit/), if possible):
58+
59+
```bash
60+
git add CONTRIBUTORS.md
61+
git commit -m "<your message>"
62+
```
63+
- Push the code *to your repository*.
64+
```bash
65+
git push origin <branch-name>
66+
```
67+
- Go to the GitHub page of _your fork_, and make a pull request:
68+
69+
![pull request image](https://help.github.com/assets/images/help/pull_requests/choose-base-and-compare-branches.png)
70+
71+
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).
72+
- Now wait, until one of us reviews your Pull Request! If there are any conflicts, you will get a notification.
3773

3874
## README Template for scripts
39-
[README Template](https://github.com/chavarera/python-mini-projects/blob/master/README_TEMPLATE.md)
4075

76+
[README Template](https://github.com/chavarera/python-mini-projects/blob/master/README_TEMPLATE.md)
4177

4278
## Connect On Social media
79+
4380
[Join WhatsApp group](https://chat.whatsapp.com/Ghp25kidWLaGrAVA0G0GAa)
4481

4582
## Contributors ✨

README_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A short description about the script must be mentioned here.
44

55
### Prerequisites
66
<!--Remove the below lines and add yours -->
7-
Things required to be able to use the script successfully and how to install them.(Including a requirements.txt file will work)
7+
Modules required to be able to use the script successfully and how to install them. (Including a requirements.txt file will work.)
88

99
### How to run the script
1010
<!--Remove the below lines and add yours -->
@@ -14,6 +14,6 @@ Steps on how to run the script along with suitable examples.
1414
<!--Remove the below lines and add yours -->
1515
Add a jpeg/png/gif file here.
1616

17-
## Author Name
17+
## *Author Name*
1818
<!--Remove the below lines and add yours -->
1919
Your name goes here.

0 commit comments

Comments
 (0)