Skip to content

Commit 95afc26

Browse files
authored
Create CONTRIBUTING.md
1 parent e46ac18 commit 95afc26

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

CONTRIBUTING.md

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

0 commit comments

Comments
 (0)