|
| 1 | +## Contribution Guidelines |
| 2 | + |
| 3 | +- Select an issue and ask to be *assigned* to it. |
| 4 | +- Check existing scripts [project here.](https://github.com/Python-World/snippets) |
| 5 | +- **Star** the repository. |
| 6 | +- On the [GitHub page for this repository](https://github.com/Python-World/snippets), click on the Button "**Fork**". |
| 7 | +  |
| 8 | +- Create clone ***your forked repository*** on your local machine. |
| 9 | +  |
| 10 | + |
| 11 | + For example, run this command inside your terminal: |
| 12 | + |
| 13 | + ```bash |
| 14 | + git clone https://github.com/<your-github-username>/snippets.git |
| 15 | + ``` |
| 16 | + |
| 17 | + **Replace \<your-github-username\>!** |
| 18 | + |
| 19 | + 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). |
| 20 | +- 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: |
| 21 | + |
| 22 | + ```bash |
| 23 | + git remote add upstream https://github.com/Python-World/snippets.git |
| 24 | + git fetch upstream |
| 25 | + git pull upstream master |
| 26 | + git push |
| 27 | + ``` |
| 28 | + |
| 29 | +- 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). |
| 30 | + |
| 31 | +- Checkout to development branch (*name your branch according to the issue name*). |
| 32 | + |
| 33 | + ```bash |
| 34 | + git checkout -b <branch-name> |
| 35 | + ``` |
| 36 | + |
| 37 | +- Create a folder in one of the folders in the [Scripts' directory](https://github.com/Python-World/snippets/tree/master/snippets) according to issue name. |
| 38 | +- Write your code and add to the respective folder in the projects directory, locally. |
| 39 | +- 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) |
| 40 | +- Add the changes with `git add`, `git commit` ([write a good commit message](https://chris.beams.io/posts/git-commit/), if possible): |
| 41 | + |
| 42 | + ```bash |
| 43 | + git add -A |
| 44 | + git commit -m "<your message>" |
| 45 | + ``` |
| 46 | + |
| 47 | +- Push the code *to your repository*. |
| 48 | + |
| 49 | + ```bash |
| 50 | + git push origin <branch-name> |
| 51 | + ``` |
| 52 | + |
| 53 | +- Go to the GitHub page of _your fork_, and **make a pull request**: |
| 54 | + |
| 55 | +  |
| 56 | + |
| 57 | + 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). |
| 58 | +- Now wait, until one of us *reviews your Pull Request*! If there are any conflicts, you will get a notification. |
0 commit comments