CONTRIBUTING.md

Contributing

First fork the repo to your account.

Then setup your local environment:

# Subsitute with your github user
user="your github username"

# Clone it
git clone [email protected]:$user/virsnap.git
# or: git clone https://github.com/$user/virsnap.git

# Set remote
git remote add upstream [email protected]:joroec/virsnap.git
# or: git remote add upstream https://github.com/joroec/virsnap.git

# Don't push to upstream
git remote set-url --push upstream no_push

# Check it all makes sense
git remote -v

Update your local master:

cd virsnap
git fetch upstream
git checkout master
git rebase upstream/master

Create a feature branch:

git checkout -b feature_branch

Keeping your local branch in sync:

# While on your feature_branch
git fetch upstream
git rebase upstream/master

After adding your changes, commit them:

git commit

Then push your changes to your local repository. If you rebased during development you might need to force-push:

git push -f

Lastly go to your fork on Github and create a pull request. Assign one of the authors from the AUTHORS file to review it.