How to contribute to an open-source GitHub project using your own fork

Posted on January 09, 2017 | By Matt Stauffer

I just recently joined a new open source project, and there were a few folks on the team who weren't familiar with how to contribute to an open source project by forking your own copy, so I wrote this up for the docs of that project. I figured I'd also share it here.

If you join a new open source project, it's very likely that you won't get direct access to push commits or branches up to the repository itself. So, instead, you'll fork the repo, make the changes on your version of the repo, and then "pull request" your changes back to the original.

Here are the steps to take.

Let's use the general-congress-hotline project as an example. First, visit its page on GitHub , and click the "Fork" icon in the upper right of the page.

This will create a fork of the project under your user account.

Cloning it locally

Next, clone your local version down to your local machine.


How to contribute to an open-source GitHub project using your own fork - Matt St ...
git clone [email protected]:mattstauffer/general-congress-hotline.git

You now have a local representation of your fork.

Keeping in sync with the source

In order to make it easy to keep your fork in sync with the original, add the original as a remote:

git remote add upstream https://github.com/StayWokeOrg/general-congress-hotline.git

If you check your remotes ( git remote -v ), you can now see that you have two "remotes" that your local repo is pointed towards: origin , which points to your repo, and upstream , which points to the original. We'll get to why in a bit.

Spinning up a branch

Since you want to branch from the development branch, make sure you're on the development branch and it's up-to-date with the source repo. If you just forked it, it always will be―but if there have been a lot of changes to the original repo since you forked it, yours might be out of sync. Here's how to get yours in sync:

git checkout development git fetch upstream git merge upstream/development git push origin development

Now you can spin up your new branch:

git checkout -b my-feature-name

Make your changes, commit them, and push up to your forked repo for that branch:

touch new-file.text git add new-file.txt git commit -m "Added new-file.text" git push origin my-feature-name

Now, you can create a PR in the GitHub user interface. Visit your repo on GitHub and click the "New Pull Request" button, and you can create your PR from there.


How to contribute to an open-source GitHub project using your own fork - Matt St ...

Make sure to explain the purpose, context, and anything else necessary for reviewers to understand the PR. See GitHub's " How to write the perfect pull request ".


How to contribute to an open-source GitHub project using your own fork - Matt St ...

That's it!

本文开发(php)相关术语:php代码审计工具 php开发工程师 移动开发者大会 移动互联网开发 web开发工程师 软件开发流程 软件开发工程师

主题: GitGitHub
分页:12
转载请注明
本文标题:How to contribute to an open-source GitHub project using your own fork - Matt St ...
本站链接:http://www.codesec.net/view/522549.html
分享请点击:


1.凡CodeSecTeam转载的文章,均出自其它媒体或其他官网介绍,目的在于传递更多的信息,并不代表本站赞同其观点和其真实性负责;
2.转载的文章仅代表原创作者观点,与本站无关。其原创性以及文中陈述文字和内容未经本站证实,本站对该文以及其中全部或者部分内容、文字的真实性、完整性、及时性,不作出任何保证或承若;
3.如本站转载稿涉及版权等问题,请作者及时联系本站,我们会及时处理。
登录后可拥有收藏文章、关注作者等权限...
技术大类 技术大类 | 开发(php) | 评论(0) | 阅读(38)