Skip to content

Home

Jump to bottom Edit New page
Caleb Eby edited this page Dec 3, 2016 · 15 revisions

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
  1. Remove the git directory to remove all history
rm -rf .git
  1. Update module name in package.json and README.md
  2. Create a new GitHub repository without initializing with a README.md
  3. Push up your new JSTransformer to GitHub
git init
git remote add origin git@github.com:jstransformers/jstransformer-NAMEHERE.git
git push origin master
  1. Activate Travis CI and Coveralls
  2. Let the fun begin!

Update

To update a transform to the latest boilerplate:

  1. Bring in the latest changes from Boilerplate
git pull https://github.com/jstransformers/boilerplate.git master
  1. Add all changes
git add -A
  1. Create a new branch
git checkout -b boilerplate
  1. Resolve all conflicts
  2. Run tests to ensure everything is working
npm install
npm test
  1. Commit your changes and push them up to the boilerplate remote
git add -A
git commit
git push origin boilerplate
  1. Create a Pull Request with the boilerplate update, and dance! 💃
Add a custom footer
Add a custom sidebar
Clone this wiki locally