Skip to content

Commit 5532236

Browse files
ndleahndleah
committed
Update README.md
1 parent d663cf3 commit 5532236

File tree

1 file changed

+163
-1
lines changed

1 file changed

+163
-1
lines changed

‎README.md

+163-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,164 @@
1-
# python-mini-project
1+
![Star Badge](https://img.shields.io/static/v1?label=%F0%9F%8C%9F&message=If%20Useful&style=style=flat&color=BC4E99)
2+
![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)
3+
[![View My Profile](https://img.shields.io/badge/View-My_Profile-green?logo=GitHub)](https://github.com/nduongthucanh)
4+
[![View Repositories](https://img.shields.io/badge/View-My_Repositories-blue?logo=GitHub)](https://github.com/nduongthucanh?tab=repositories)
5+
6+
[![forthebadge](https://forthebadge.com/images/badges/powered-by-coffee.svg)](https://forthebadge.com)
7+
[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com)
8+
[![forthebadge](https://forthebadge.com/images/badges/built-with-swag.svg)](https://forthebadge.com)
9+
[![forthebadge](https://forthebadge.com/images/badges/made-with-python.svg)](https://forthebadge.com)
10+
11+
12+
# Python Mini Projects
13+
14+
![Issues](https://img.shields.io/github/issues/nduongthucanh/python-mini-project)
15+
![Pull Requests](https://img.shields.io/github/issues-pr/nduongthucanh/python-mini-project)
16+
![Forks](https://img.shields.io/github/forks/nduongthucanh/python-mini-project)
17+
![Stars](https://img.shields.io/github/stars/nduongthucanh/python-mini-project)
18+
219
A collection of easy Python small projects to help you improve your programming skills.
20+
21+
## 📜 **Steps to follow**
22+
23+
### 1. 🌟 Star The Repo
24+
25+
Star the repo by pressing the topmost-right button to start your wonderful journey
26+
27+
---
28+
29+
### 2. 🍴 **Fork it**
30+
31+
On the [GitHub page for this repository](https://github.com/nduongthucanh/python-mini-project), click on the Button "**Fork**".
32+
33+
![fork image](https://help.github.com/assets/images/help/repository/fork_button.jpg)
34+
35+
---
36+
37+
### 3. 👥 **Clone it**
38+
39+
* **Method 1:** GitHub Desktop
40+
41+
> ⚠️ **NOTE:** If you're not familiar with Git, using **GitHub Desktop Application** is a better start. If you choose this method, make sure to download it before continuing reading.
42+
>
43+
> ❗❗ Access link to download [**here**](https://desktop.github.com).
44+
45+
Learn more about how to clone the remote respository on your local machine using **GitHub Desktop** [here](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop#cloning-a-repository).
46+
47+
* **Method 2:** Git
48+
49+
To create clone ***your forked repository*** on your local machine, run this command inside your terminal:
50+
51+
```bash
52+
git clone https://github.com/<your-github-username>/python-mini-project.git
53+
```
54+
55+
> This makes a local copy of the repository in your machine.
56+
>
57+
⚠️ **Replace \<your-github-username\>!**
58+
59+
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).
60+
61+
---
62+
63+
### 4. ⬆️ Set it up
64+
* **Method 1:** GitHub Desktop
65+
66+
Learn more about how to clone the remote respository on your local machine using **GitHub Desktop** [here](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop#cloning-a-repository).
67+
68+
* **Method 2:** Git
69+
70+
Run the following commands to see that *your local copy* has a reference to *your forked remote repository* in Github :octocat:
71+
72+
```sh
73+
$ git remote -v
74+
origin https://github.com/Your_Username/python-mini-project.git (fetch)
75+
origin https://github.com/Your_Username/python-mini-project.git (push)
76+
```
77+
78+
Now, let's add a reference to the original [Python mini project](https://github.com/nduongthucanh/python-mini-project/) repository using
79+
80+
```sh
81+
$ git remote add upstream https://github.com/srimani-programmer/Breast-Cancer-Predictor.git
82+
```
83+
84+
> This adds a new remote named ***upstream***.
85+
86+
---
87+
88+
### 5. ♻️ Sync it
89+
90+
Always keep your local copy of the repository updated with the original repository.
91+
Before making any changes and/or in an appropriate interval, follow the following steps:
92+
93+
* **Method 1:** GitHub Desktop
94+
95+
Learn more about how to fetch and pull origin from/to your local machine using **GitHub Desktop** [here](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/keeping-your-local-repository-in-sync-with-github/syncing-your-branch).
96+
97+
* **Method 2:** Git
98+
99+
Run the following commands ***carefully*** to update your local repository
100+
101+
```sh
102+
# Fetch all remote repositories and delete any deleted remote branches
103+
$ git fetch --all --prune
104+
105+
# Switch to `New_Pipeline` branch
106+
$ git checkout New_Pipeline
107+
108+
# Reset local `main` branch to match the `upstream` repository's `main` branch
109+
$ git reset --hard upstream/main
110+
111+
# Push changes to your forked `Breast-Cancer-Predictor` repo
112+
$ git push -u origin New_Pipeline
113+
```
114+
---
115+
116+
### 6. 🐇 Ready, Set, Go...
117+
118+
Once you have completed these steps, you are ready to start contributing to the project and creating **pull requests**.
119+
120+
- Create a folder in
121+
[projects directory](https://github.com/nduongthucanh/python-mini-project) according to issue name.
122+
- Write your code and add to the respective folder in the projects directory, locally.
123+
- Don't forget to add a `README.md` in your folder, according to the
124+
[README_TEMPLATE.](https://github.com/Python-World/python-mini-projects/blob/master/README_TEMPLATE.md)
125+
126+
* **Method 1:** GitHub Desktop
127+
128+
Learn more how to pull request from your local machine using **GitHub Desktop** to the main repo [here](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop).
129+
130+
* **Method 2:** Git
131+
132+
Add the changes with `git add`, `git commit`:
133+
134+
```bash
135+
git add -A
136+
git commit -m "<your message>"
137+
```
138+
139+
Push the code *to your repository*.
140+
141+
```bash
142+
git push origin <branch-name>
143+
```
144+
### 7. 🐢 Pull Request
145+
146+
Go to the GitHub page of _your fork_, and **make a pull request**:
147+
148+
![pull request image](https://help.github.com/assets/images/help/pull_requests/choose-base-and-compare-branches.png)
149+
150+
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).
151+
152+
Now wait, until *your Pull Request* is approved! If there are any conflicts, you will get a notification.
153+
154+
## README Template for scripts
155+
156+
[README Template](https://github.com/nduongthucanh/python-mini-project/blob/master/README_TEMPLATE.md)
157+
158+
## Projects ✨
159+
160+
SR No | Project | Author
161+
--- | --- | ---
162+
1 | [Dice Rolling Stimulator](https://github.com/nduongthucanh/python-mini-project/tree/main/Dice_Rolling_Stimulator) | [Leah Nguyen](https://github.com/nduongthucanh)
163+
2 | [Dictionary](https://github.com/nduongthucanh/python-mini-project/tree/main/Dictionary)| [Leah Nguyen](https://github.com/nduongthucanh)
164+
3 | [Hangman Game](https://github.com/nduongthucanh/python-mini-project/tree/main/Hangman_Game) | [Leah Nguyen](https://github.com/nduongthucanh)

0 commit comments

Comments
 (0)