Skip to content

Contributing to BEE

Jump to bottom
Allen McPherson edited this page Dec 20, 2019 · 5 revisions

Don't trust any of this now. I don't understand all of it yet.

Contributions to BEE are accepted as pull requests. You'll need to fork the BEE repository, create your bug/feature branch (we don't develop on the master branch), and submit a pull request with the master branch as the target. Outlined below are the steps necessary to employ this workflow.

  1. Click the Fork button at the top of the BEE_Private repo. This will fork the repository into your personal account. Note that since the BEE_Private repository is private, your forked version will be as well. You can not make a forked private repository public. For others to see your private personal you need to add them as collaborators.

  2. Clone your forked repository and cd BEE_Private.

  3. Make sure to set your Git configuration locally if you don't have it set locally (e.g. git config -local user.email ...).

  4. Add an upstream remote reference to your personal repo:

> git remote add upstream git@github.com:your_user_name/BEE_Private.git
> git remote -v
  1. Make sure you're on the master branch. Update your personal repo with any changes that have been made to the original repo.
BEE_Private (master) » git fetch upstream
BEE_Private (master) » git rebase upstream/master
  1. To work on an existing branch:
BEE_Private (master) » git checkout --track origin/rpyc-example-servers
Branch rpyc-example-servers set up to track remote branch rpyc-example-servers from origin.
Switched to a new branch 'rpyc-example-servers'
BEE_Private (rpyc-example-servers) »
  1. To create a new branch:
git checkout -b bogosity
git add -A
git commit -m "Bogus commit to test new branch on fork"
git push --set-upstream origin bogosity
git checkout master
git pull origin master
git fetch origin master
git merge
git merge bogosity
Clone this wiki locally