mirror/pcottle.learnGitBranching
1
0
Fork 0
mirror of https://github.com/pcottle/learnGitBranching.git synced 2025-07-09 22:24:26 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

readme update

Browse source
This commit is contained in:
Peter Cottle 2013-12-22 14:36:36 -08:00
parent 8d503d6049
commit 2c982b704b
1 changed files with 12 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -59,7 +59,8 @@ Thus, if you build the app locally, all you have to do in order to run the app i
## Building yourself / Contributing Functionality ## Building yourself / Contributing Functionality
For contributing core functionality in the app, you'll probably want to test your changes For contributing core functionality in the app, you'll probably want to test your changes
at least once before submitting a pull request. That means you'll need the `grunt` build tool: at least once before submitting a pull request. That means you'll need the "Grunt.js" build tool to build the app:
http://gruntjs.com/getting-started http://gruntjs.com/getting-started
You'll also need `npm` to download all the dependencies of the project. You'll also need `npm` to download all the dependencies of the project.
@ -70,12 +71,17 @@ The general workflow / steps are below:
git clone <your fork of the repo> git clone <your fork of the repo>
cd learnGitBranching cd learnGitBranching
npm install # to install all the node modules I depend on npm install # to install all the node modules I depend on
git checkout -b newAwesomeFeature git checkout -b newAwesomeFeature
# some changes vim ./src/js/git/index.js # some changes
grunt fastBuild grunt fastBuild # skips tests and linting, faster build
# after building you can open up your browser to the index.html that is generated and see your changes
# more changes # after building you can open up your browser to the index.html
grunt build # file generated and see your changes
vim ./src/js/git/index.js # more changes
grunt build # runs tests and lint
git commit -am "My new sweet feature!" git commit -am "My new sweet feature!"
git push git push
# go online and request a pull # go online and request a pull