Home

This is the Boilerplate to create and update JSTransformers.

Usage

Create

To create a new JSTransformer:

1. Download Boilerplate with git

git clone https://github.com/jstransformers/boilerplate.git
cd boilerplate

2. Remove origin, since we'll add our own

git remote remove origin

3. Update module name in package.json and README.md
4. Create a new GitHub repository without initializing with a README.md
5. Push up your new JSTransformer to GitHub

git remote add origin git@github.com:jstransformers/jstransformer-NAMEHERE.git
git push origin master

6. Activate Travis CI and Coveralls
7. Let the fun begin!

Update

To update a transform to the latest boilerplate:

1. Create a new boilerplate branch

git checkout -b boilerplate

2. Bring in the latest changes from Boilerplate

git remote add boilerplate https://github.com/jstransformers/boilerplate.git
git fetch --all
git pull boilerplate master

3. Resolve merge conflicts and update instances of foo accordingly
4. Run tests to ensure everything is working

npm install
npm test

5. Commit your changes and push them up to the boilerplate remote

git add -A
git commit
git push origin boilerplate

6. Create a Pull Request with the boilerplate update, and dance! 💃