|
5 | 5 |  |
6 | 6 |  |
7 | 7 |  |
8 | | - |
| 8 | + |
9 | 9 |  |
10 | 10 |
|
11 | 11 | [](https://forthebadge.com) |
|
15 | 15 |
|
16 | 16 | # Mini-Projects-Python |
17 | 17 |
|
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. |
19 | 19 |
|
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) |
21 | 21 |
|
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) |
23 | 23 |
|
24 | 24 | ## Steps To Follow |
25 | 25 |
|
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 | +  |
| 31 | +- Create clone ***your forked repository*** on your local machine. |
| 32 | +  |
| 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 | + ```basg |
| 54 | + git checkout -b <branch-name> |
| 55 | + ``` |
| 56 | +- Create a folder in [projects directory](https://github.com/chavarera/python-mini-projects/tree/master/projects) according to issue name. |
| 57 | +- Write your code and add to the respective folder in the projects directory, locally. |
| 58 | +- 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) |
| 59 | +- Add the changes with `git add`, `git commit` ([write a good commit message](https://chris.beams.io/posts/git-commit/), if possible): |
| 60 | + |
| 61 | + ```bash |
| 62 | + git add CONTRIBUTORS.md |
| 63 | + git commit -m "<your message>" |
| 64 | + ``` |
| 65 | +- Push the code *to your repository*. |
| 66 | + ```bash |
| 67 | + git push origin <branch-name> |
| 68 | + ``` |
| 69 | +- Go to the GitHub page of _your fork_, and make a pull request: |
| 70 | + |
| 71 | +  |
| 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. |
37 | 75 | |
38 | 76 | ## README Template for scripts |
39 | | -[README Template](https://github.com/chavarera/python-mini-projects/blob/master/README_TEMPLATE.md) |
40 | 77 | |
| 78 | +[README Template](https://github.com/chavarera/python-mini-projects/blob/master/README_TEMPLATE.md) |
41 | 79 | |
42 | 80 | ## Connect On Social media |
| 81 | + |
43 | 82 | [Join WhatsApp group](https://chat.whatsapp.com/Ghp25kidWLaGrAVA0G0GAa) |
44 | 83 | |
45 | 84 | ## Contributors ✨ |
|
0 commit comments