Skip to content

Home

Jump to bottom Edit New page
Kevin Van Lierde edited this page Dec 11, 2021 · 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. 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 newjstransformer [email protected]:jstransformers/jstransformer-NAMEHERE.git
git push newjstransformer master
  1. Activate Travis CI
  2. Let the fun begin!

Update

To update a transform to the latest boilerplate:

  1. Create a new branch
git checkout -b boilerplate
  1. Bring in the latest changes from Boilerplate
git pull https://github.com/jstransformers/boilerplate.git master

  1. Manually resolve merge 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