Skip to content

Instantly share code, notes, and snippets.

@MorpheusH3x
Last active August 16, 2021 10:37
Show Gist options
  • Save MorpheusH3x/b37c6afa244d2d68b2ab750b8b8321c1 to your computer and use it in GitHub Desktop.
Save MorpheusH3x/b37c6afa244d2d68b2ab750b8b8321c1 to your computer and use it in GitHub Desktop.
Properly contribute to an open source project
Source: https://www.dataschool.io/how-to-contribute-on-github/
# Initialisation
1. Fork the project on Github.
2. `git clone URL_OF_FORK`
3. `cd NAME_OF_REPOSITORY`
4. Check if there is a `origin` when executing `git remote -v`
If not, run `git remote add origin URL_OF_FORK`
5. Setup upstream
`git remote add upstream URL_OF_PROJECT`
# Working with it
1. Pull the changes from the "master" branch of the "upstream" into your local repository
`git pull upstream master`
2. Create a nex branch
`git checkout -b BRANCH_NAME`
3. Make the changes in your local repository
4. Commit your changes
`git add -A`
`git commit`
5. Push your changes to your fork
`git push origin BRANCH_NAME`
6. Begin the pull request:
Return to your fork on GitHub, and refresh the page. You may see a highlighted area that displays your recently pushed branch.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment