forked from HarshCasper/Rotten-Scripts
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
44e5c7c
commit 9b2c9de
Showing
4 changed files
with
172 additions
and
125 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,106 +1,117 @@ | ||
| # Contributing Guidelines | ||
|
|
||
| This documentation contains a set of guidelines to help you during the contribution process. | ||
| 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.** | ||
| # Contributing Guidelines | ||
|
|
||
| This documentation contains a set of guidelines to help you during the contribution process. | ||
| 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.** | ||
|
|
||
| Before anything, kindly go through our [Styling-Guidelines](STYLE_GUIDELINES.md) as well. | ||
|
|
||
| # Submitting Contributions👩💻👨💻 | ||
| ## Submitting Contributions👩💻👨💻 | ||
|
|
||
| Below you will find the process and workflow used to review and merge your changes. | ||
| Below you will find the process and workflow used to review and merge your changes. | ||
|
|
||
| ## Step 0 : Find an issue | ||
| ### Step 0 : Find an issue | ||
|
|
||
| - Take a look at the Existing Issues or create your **own** Issues! | ||
| - Wait for the Issue to be assigned to you after which you can start working on it. | ||
| - Note : Every change in this project should/must have an associated issue. | ||
|  | ||
|
|
||
| ## Step 1 : Fork the Project | ||
|
|
||
| - 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. | ||
| - Take a look at the Existing Issues or create your **own** Issues! | ||
| - Wait for the Issue to be assigned to you after which you can start working on it. | ||
| - Note : Every change in this project should/must have an associated issue. | ||
|
|
||
| ``` | ||
| $ git clone https://github.com/<your-username>/<repo-name> | ||
| $ cd <repo-name> | ||
| $ git remote add upstream https://github.com/<upstream-owner>/<repo-name> | ||
|  | ||
|
|
||
| ### Step 1 : Fork the Project | ||
|
|
||
| - 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. | ||
|
|
||
| ```bash | ||
| git clone https://github.com/<your-username>/<repo-name> | ||
| cd <repo-name> | ||
| git remote add upstream https://github.com/<upstream-owner>/<repo-name> | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| - If you have already forked the project, update your copy before working. | ||
|
|
||
| ``` | ||
| $ git remote update | ||
| $ git checkout <branch-name> | ||
| $ git rebase upstream/<branch-name> | ||
| - If you have already forked the project, update your copy before working. | ||
|
|
||
| ```bash | ||
| git remote update | ||
| git checkout <branch-name> | ||
| git rebase upstream/<branch-name> | ||
| ``` | ||
|
|
||
| ## Step 2 : Branch | ||
| ### Step 2 : Branch | ||
|
|
||
| Create a new branch. Use its name to identify the issue your addressing. | ||
| Create a new branch. Use its name to identify the issue your addressing. | ||
|
|
||
| ``` | ||
| ```bash | ||
| # It will create a new branch with name Branch_Name and switch to that branch | ||
| $ git checkout -b branch_name | ||
| ``` | ||
| git checkout -b branch_name | ||
| ``` | ||
|
|
||
| ## Step 3 : Work on the issue assigned | ||
| ### Step 3 : Work on the issue assigned | ||
|
|
||
| - Work on the issue(s) assigned to you. | ||
| - Add all the files/folders needed. | ||
| - After you've made changes or made your contribution to the project add changes to the branch you've just created by: | ||
| - Work on the issue(s) assigned to you. | ||
| - Add all the files/folders needed. | ||
| - After you've made changes or made your contribution to the project add changes to the branch you've just created by: | ||
|
|
||
| ``` | ||
| ```bash | ||
| # To add all new files to branch Branch_Name | ||
| $ git add . | ||
| git add . | ||
|
|
||
| # To add only a few files to Branch_Name | ||
| $ git add <some files> | ||
| git add <some files> | ||
| ``` | ||
|
|
||
| ## Step 4 : Commit | ||
|
|
||
| - To commit give a descriptive message for the convenience of reviewer by: | ||
| ### Step 4 : Commit | ||
|
|
||
| ``` | ||
| - To commit give a descriptive message for the convenience of reviewer by: | ||
|
|
||
| ```bash | ||
| # This message get associated with all files you have changed | ||
| $ git commit -m "message" | ||
| ``` | ||
| git commit -m "message" | ||
| ``` | ||
|
|
||
| - **NOTE**: A PR should have only one commit. Multiple commits should be squashed. | ||
|
|
||
| ## Step 5 : Work Remotely | ||
|
|
||
| - Now you are ready to your work to the remote repository. | ||
| - When your work is ready and complies with the project conventions, upload your changes to your fork: | ||
|
|
||
| ``` | ||
| # To push your work to your remote repository | ||
| $ git push -u origin Branch_Name | ||
| ``` | ||
| - **NOTE**: A PR should have only one commit. Multiple commits should be squashed. | ||
|
|
||
| ### Step 5 : Work Remotely | ||
|
|
||
| - Now you are ready to your work to the remote repository. | ||
| - When your work is ready and complies with the project conventions, upload your changes to your fork: | ||
|
|
||
| ```bash | ||
| # To push your work to your remote repository | ||
| git push -u origin Branch_Name | ||
| ``` | ||
|
|
||
| - Here is how your branch will look. | ||
|  | ||
|
|
||
| ### Step 6 : Pull Request | ||
|
|
||
| - Here is how your branch will look. | ||
|  | ||
|
|
||
| ## Step 6 : Pull Request | ||
|
|
||
| - 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. | ||
| - 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. | ||
| <img width="677" alt="pr" src="https://user-images.githubusercontent.com/44089458/86090744-4b6ece80-bac8-11ea-9d69-a0098e9d4874.PNG"> | ||
|
|
||
| <img width="882" alt="pullr" src="https://user-images.githubusercontent.com/44089458/86092345-fed8c280-baca-11ea-9a04-95991d9c60d2.PNG"> | ||
| - Voila! Your Pull Request has been submitted and will be reviewed by the moderators and merged.🥳 | ||
|
|
||
| ## Need more help?🤔 | ||
|
|
||
| You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck: | ||
|
|
||
| - [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) | ||
| - [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request) | ||
| - [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github) | ||
| - [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6) | ||
| - [Learn GitHub from Scratch](https://lab.github.com/githubtraining/introduction-to-github) | ||
|
|
||
|
|
||
| ## Tip from us😇 | ||
|
|
||
| It always takes time to understand and learn. So, do not worry at all. We know **you have got this**!💪 | ||
| - Voila! Your Pull Request has been submitted and will be reviewed by the moderators and merged.🥳 | ||
|
|
||
| ### Need more help?🤔 | ||
|
|
||
| You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, | ||
| in case you are stuck: | ||
|
|
||
| - [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) | ||
| - [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request) | ||
| - [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github) | ||
| - [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6) | ||
| - [Learn GitHub from Scratch](https://lab.github.com/githubtraining/introduction-to-github) | ||
|
|
||
| ### Tip from us😇 | ||
|
|
||
| It always takes time to understand and learn. So, do not worry at all. We know **you have got this**!💪 | ||
|
|
||
| ### Specific tips on Python?:snake: | ||
|
|
||
| You are a pythonista? Welcome aboard! Before anything, see our | ||
| [python contribution guide](Python/CONTRIBUTION-GUIDELINE.md) as well, it is basically | ||
| an extension to these guidelines. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.