-
Notifications
You must be signed in to change notification settings - Fork 16
How to contribute to var_masterpiece
Philip Reasa edited this page Aug 7, 2016
·
1 revision
#Contributing This is meant to be a rather complete documentation covering everything from github to chrome extensions. If you already know how to make a PR (or anything else talked about here) feel free to skip that section :)
##Github In github the way to contribute is a Pull Request (PR). Basically, you provide me with a branch of code that you want me to integrate. I'll look over it, make sure it is good, and then merge it into the mainstream.
There are plenty of documents about how to use git, but in short this is what you need to do.
-
git clone https://github.com/Rece/var_dump.git
- clone my repo -
git pull origin master
- make sure that your code is up to date with my master branch -
git checkout -b <YOUR_BRANCH_NAME>
- create a new branch for your changes - ...make changes to files...
- test your changes (see below)
-
git diff .
- make sure you only changed the things you wanted to change -
git add .
- have git watch those changes -
git commit -m
- add those changes to your branch -
git push origin <YOUR_BRANCH_NAME>
- push your branch to github - Log into github, go the the repo https://github.com/Rece/var_dump
- click
Pull Requests
- click
New Pull Request
, and choose your new branch.
##Testing a chrome extension It is actually pretty easy to test out a chrome extension.
- Disable your currently active var_masterpiece. Go to
chrome://extensions
and un-select enable on var_masterpiece (we don't want the test version fighting with the real version) - Click
load unpacked extension
- Select the
var_masterpiece_extension
folder from your file system. - When you make changes, all you have to do is click
reload