|
1 | | -# Contributing Guidelines |
2 | | - |
3 | | -This documentation contains a set ofguidelines to help you during the contribution process. |
4 | | -We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, **no contribution is too small.** |
5 | | - |
6 | | -# Submitting Contributions👩💻👨💻 |
7 | | -Below you will find the process and workflow used to review and merge your changes. |
8 | | -## Step 0 : Find an issue |
9 | | -- Take a look at the Existing Issues or create your **own** Issues! |
10 | | -- Wait for the Issue to be assigned to you after which you can start working on it. |
11 | | -- Note : Every change in this project should/must have an associated issue. |
12 | | - |
13 | | - |
14 | | -## Step 1 : Fork the Project |
15 | | -- Fork this Repository. This will create a Local Copy of this Repository on your Github Profile. Keep a reference to the original project in `upstream` remote. |
16 | | -``` |
17 | | -$ git clone https://github.com/<your-username>/<repo-name> |
18 | | -$ cd <repo-name> |
19 | | -$ git remote add upstream https://github.com/<upstream-owner>/<repo-name> |
20 | | -``` |
21 | | - |
22 | | - |
23 | | -- If you have already forked the project, update your copy before working. |
24 | | -``` |
25 | | -$ git remote update |
26 | | -$ git checkout <branch-name> |
27 | | -$ git rebase upstream/<branch-name> |
28 | | -``` |
29 | | -## Step 2 : Branch |
30 | | -Create a new branch. Use its name to identify the issue your addressing. |
31 | | -``` |
| 1 | +# Contributing Guidelines |
| 2 | + |
| 3 | +This documentation contains a set of guidelines to help you during the contribution process. |
| 4 | +We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, **no contribution is too small.** |
| 5 | + |
| 6 | +# Submitting Contributions👩💻👨💻 |
| 7 | +Below you will find the process and workflow used to review and merge your changes. |
| 8 | +## Step 0 : Find an issue |
| 9 | +- Take a look at the Existing Issues or create your **own** Issues! |
| 10 | +- Wait for the Issue to be assigned to you after which you can start working on it. |
| 11 | +- Note : Every change in this project should/must have an associated issue. |
| 12 | + |
| 13 | + |
| 14 | +## Step 1 : Fork the Project |
| 15 | +- Fork this Repository. This will create a Local Copy of this Repository on your Github Profile. Keep a reference to the original project in `upstream` remote. |
| 16 | +``` |
| 17 | +$ git clone https://github.com/<your-username>/<repo-name> |
| 18 | +$ cd <repo-name> |
| 19 | +$ git remote add upstream https://github.com/<upstream-owner>/<repo-name> |
| 20 | +``` |
| 21 | + |
| 22 | + |
| 23 | +- If you have already forked the project, update your copy before working. |
| 24 | +``` |
| 25 | +$ git remote update |
| 26 | +$ git checkout <branch-name> |
| 27 | +$ git rebase upstream/<branch-name> |
| 28 | +``` |
| 29 | +## Step 2 : Branch |
| 30 | +Create a new branch. Use its name to identify the issue your addressing. |
| 31 | +``` |
32 | 32 | # It will create a new branch with name Branch_Name and switch to that branch |
33 | | -$ git checkout -b branch_name |
34 | | -``` |
35 | | -## Step 3 : Work on the issue assigned |
36 | | -- Work on the issue(s) assigned to you. |
37 | | -- Add all the files/folders needed. |
38 | | -- After you've made changes or made your contribution to the project add changes to the branch you've just created by: |
39 | | -``` |
40 | | -# To add all new files to branch Branch_Name |
41 | | -$ git add . |
42 | | -``` |
43 | | -## Step 4 : Commit |
44 | | -- To commit give a descriptive message for the convenience of reveiwer by: |
45 | | -``` |
46 | | -# This message get associated with all files you have changed |
47 | | -$ git commit -m 'message |
48 | | -``` |
49 | | -- **NOTE**: A PR should have only one commit. Multiple commits should be squashed. |
50 | | -## Step 5 : Work Remotely |
51 | | -- Now you are ready to your work to the remote repository. |
52 | | -- When your work is ready and complies with the project conventions, upload your changes to your fork: |
| 33 | +$ git checkout -b branch_name |
| 34 | +``` |
| 35 | +## Step 3 : Work on the issue assigned |
| 36 | +- Work on the issue(s) assigned to you. |
| 37 | +- Add all the files/folders needed. |
| 38 | +- After you've made changes or made your contribution to the project add changes to the branch you've just created by: |
| 39 | +``` |
| 40 | +# To add all new files to branch Branch_Name |
| 41 | +$ git add . |
53 | 42 |
|
| 43 | +# To add only a few files to Branch_Name |
| 44 | +$ git add <some files> |
54 | 45 | ``` |
55 | | -# To push your work to your remote repository |
56 | | -$ git push -u origin Branch_Name |
| 46 | + |
| 47 | +## Step 4 : Commit |
| 48 | +- To commit give a descriptive message for the convenience of reviewer by: |
57 | 49 | ``` |
58 | | -- Here is how your branch will look. |
59 | | - |
60 | | - |
61 | | -## Step 6 : Pull Request |
62 | | -- Go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your contribution. |
63 | | -<img width="677" alt="pr" src="https://user-images.githubusercontent.com/44089458/86090744-4b6ece80-bac8-11ea-9d69-a0098e9d4874.PNG"> |
64 | | - |
65 | | -<img width="882" alt="pullr" src="https://user-images.githubusercontent.com/44089458/86092345-fed8c280-baca-11ea-9a04-95991d9c60d2.PNG"> |
66 | | -- Voila! Your Pull Request has been submitted and will be reviewed by the moderators and merged.🥳 |
67 | | - |
68 | | -## Need more help?🤔 |
69 | | -You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck: |
70 | | -- [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) |
71 | | -- [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request) |
72 | | -- [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github) |
73 | | -- [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6) |
74 | | -- [Learn GitHub from Scratch](https://lab.github.com/githubtraining/introduction-to-github) |
75 | | - |
76 | | - |
77 | | -## Tip from us😇 |
78 | | -It always takes time to understand and learn. So, do not worry at all. We know **you have got this**!💪 |
| 50 | +# This message get associated with all files you have changed |
| 51 | +$ git commit -m "message" |
| 52 | +``` |
| 53 | +- **NOTE**: A PR should have only one commit. Multiple commits should be squashed. |
| 54 | + |
| 55 | +## Step 5 : Work Remotely |
| 56 | +- Now you are ready to your work to the remote repository. |
| 57 | +- When your work is ready and complies with the project conventions, upload your changes to your fork: |
| 58 | + |
| 59 | +``` |
| 60 | +# To push your work to your remote repository |
| 61 | +$ git push -u origin Branch_Name |
| 62 | +``` |
| 63 | +- Here is how your branch will look. |
| 64 | + |
| 65 | + |
| 66 | +## Step 6 : Pull Request |
| 67 | +- Go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your contribution. |
| 68 | +<img width="677" alt="pr" src="https://user-images.githubusercontent.com/44089458/86090744-4b6ece80-bac8-11ea-9d69-a0098e9d4874.PNG"> |
| 69 | + |
| 70 | +<img width="882" alt="pullr" src="https://user-images.githubusercontent.com/44089458/86092345-fed8c280-baca-11ea-9a04-95991d9c60d2.PNG"> |
| 71 | +- Voila! Your Pull Request has been submitted and will be reviewed by the moderators and merged.🥳 |
| 72 | + |
| 73 | +## Need more help?🤔 |
| 74 | +You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck: |
| 75 | +- [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) |
| 76 | +- [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request) |
| 77 | +- [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github) |
| 78 | +- [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6) |
| 79 | +- [Learn GitHub from Scratch](https://lab.github.com/githubtraining/introduction-to-github) |
| 80 | + |
| 81 | + |
| 82 | +## Tip from us😇 |
| 83 | +It always takes time to understand and learn. So, do not worry at all. We know **you have got this**!💪 |
0 commit comments