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. Update module name in package.json and README.md
3. Create a new GitHub repository without initializing with a README.md
4. Push up your new JSTransformer to GitHub

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

5. Activate Travis CI
6. Let the fun begin!

Update

To update a transform to the latest boilerplate:

1. Create a new branch

git checkout -b boilerplate

2. Bring in the latest changes from Boilerplate

git pull https://github.com/jstransformers/boilerplate.git master

3. Manually resolve merge conflicts

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! 💃