|
| 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, |
| 5 | +**no contribution is too small.** |
| 6 | + |
| 7 | +# Submitting Contributions👩💻👨💻 |
| 8 | +Below you will find the process and workflow used to review and merge your changes. |
| 9 | +## Step 1 : Find an issue |
| 10 | +- Take a look at the Existing Issues or create your **own** Issues! |
| 11 | +- Wait for the Issue to be assigned to you after which you can start working on it. |
| 12 | +- Note : Every change in this project should/must have an associated issue. |
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | +## Step 2 : Fork the Project |
| 17 | +- 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. |
| 18 | +``` |
| 19 | +$ git clone https://github.com/<your-username>/Amazing-Python-Scripts |
| 20 | +$ cd Amazing-Python-Scripts |
| 21 | +$ git remote add upstream https://github.com/avinashkranjan/Amazing-Python-Scripts |
| 22 | +``` |
| 23 | + |
| 24 | + |
| 25 | + |
| 26 | +- If you have already forked the project, update your copy before working. |
| 27 | +``` |
| 28 | +$ git remote update |
| 29 | +$ git checkout <branch-name> |
| 30 | +$ git rebase upstream/<branch-name> |
| 31 | +``` |
| 32 | +## Step 3 : Branch |
| 33 | +Create a new branch. Use its name to identify the issue your addressing. |
| 34 | +``` |
| 35 | +# It will create a new branch with name Branch_Name and switch to that branch |
| 36 | +$ git checkout -b branch_name |
| 37 | +``` |
| 38 | +## Step 4 : Work on the issue assigned |
| 39 | +- Work on the issue(s) assigned to you. |
| 40 | +- Add all the files/folders needed. |
| 41 | +- After you've made changes or made your contribution to the project add changes to the branch you've just created by: |
| 42 | +``` |
| 43 | +# To add all new files to branch Branch_Name |
| 44 | +$ git add . |
| 45 | +``` |
| 46 | +## Step 5 : Commit |
| 47 | +- To commit give a descriptive message for the convenience of reveiwer by: |
| 48 | +``` |
| 49 | +# This message get associated with all files you have changed |
| 50 | +$ git commit -m 'message |
| 51 | +``` |
| 52 | +- **NOTE**: A PR should have only one commit. Multiple commits should be squashed. |
| 53 | +## Step 6 : Work Remotely |
| 54 | +- Now you are ready to your work to the remote repository. |
| 55 | +- When your work is ready and complies with the project conventions, upload your changes to your fork: |
| 56 | + |
| 57 | +``` |
| 58 | +# To push your work to your remote repository |
| 59 | +$ git push -u origin Branch_Name |
| 60 | +``` |
| 61 | + |
| 62 | +## Step 7 : Pull Request |
| 63 | +- 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. |
| 64 | + |
| 65 | +- Voila! Your Pull Request has been submitted and will be reviewed by the moderators and merged.🥳 |
| 66 | + |
| 67 | +## Need more help?🤔 |
| 68 | +You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck: |
| 69 | +- [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) |
| 70 | +- [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request) |
| 71 | +- [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github) |
| 72 | +- [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6) |
| 73 | +- [Learn GitHub from Scratch](https://lab.github.com/githubtraining/introduction-to-github) |
| 74 | + |
| 75 | + |
| 76 | +## Tip from us😇 |
| 77 | +It always takes time to understand and learn. So, do not worry at all. We know **you have got this**!💪 |
0 commit comments