Home

Developer setup instructions

1. git clone git@github.com:web-animations/web-animations-next.git
2. Install node and make sure npm is in your $PATH
3. Run npm install in the respository.
4. Run npm install -g grunt grunt-cli to get the build tools for the command line.
5. Run grunt to build the polyfill.
6. Run grunt test to run polyfill tests using the build.

Design notes

Design diagrams

Publishing a release

1. Determine the version number for the release

   • Increment the first number and reset others to 0 when there are large breaking changes
   • Increment the second number and reset the third to 0 when there are significant new, but backwards compatible features
   • Otherwise, increment the third number

2. Add versioned release notes to History.md, for example:

   ### 3.13.37 — *November 1, 2001*
   
     * Fixed a bug where nothing worked
   

   Use the following to generate a summary of commits, but edit the list to contain only relevant information.

   git log `git describe --tags --abbrev=0 web-animations-js/master`..web-animations-next/master --pretty=format:"  * %s"
   

3. Specify the new version inside package.json (for NPM), for example:

     "version": "3.13.37",

4. Commit both changes, and push to web-animations-js

5. Draft a new release at the commit pushed to web-animations-js in step #4. Copy the release notes from History.md added in step #2.

Pushing from web-animations-next to web-animations-js

git fetch web-animations-next
git fetch web-animations-js
git checkout web-animations-js/master
git merge web-animations-next/master --no-edit --quiet
npm install
grunt
git add -f *.min.js*
git rm .gitignore
git commit -m 'Add build artifacts from '`cat .git/refs/remotes/web-animations-next/master`
git push web-animations-js HEAD:refs/heads/master