1- ## Developer setup instructions
1+ ## Developer instructions
22
3- 1 . ` git clone [email protected] :web-animations/web-animations-next.git ` 3+ ### Setup
4+
5+ 1 . Fork web-animations/web-animations-js.
6+ 1 . ` git clone [email protected] :$GITHUB_USER/web-animations-js.git ` 471 . ` git submodule update --init --recursive ` (Necessary for running tests.)
581 . Install [ node] ( https://nodejs.org/en/ ) and make sure ` npm ` is in your $PATH
691 . Run ` npm install ` in the respository to pull in development dependencies.
7101 . Run ` npm install -g grunt grunt-cli ` to get the build tools for the command line.
11+
12+ ### Contributing
13+
14+ Note that development should occur against the ` dev ` branch, not ` master ` . This
15+ is the default target for pull requests.
16+
17+ 1 . In your fork of web-animations-js, ` git checkout dev ` or create a new branch whose parent is dev.
8181 . Run ` grunt ` to build the polyfill.
9191 . Run ` grunt test ` to run polyfill and web-platform-tests tests.
20+ 1 . Commit changes to your fork.
21+ 1 . Create a pull request from your fork of web-animations-js to
22+ [ web-animations/web-animations-js/dev] ( https://github.com/web-animations/web-animations-js/tree/dev ) .
1023
1124
1225## Debugging tests
@@ -18,9 +31,9 @@ browser of choice, all test results appear in the Javascript console.
1831Test failures can be accessed via ` window.failures ` and ` window.formattedFailures `
1932once the tests have completed.
2033
21- The polyfill target and tests can be specified as arguments to the ` debug ` task.
22- Example: ` grunt debug:web-animations-next:test/web-platform-tests/web-animations/animation/pause.html `
23- Multiple test files may be listed with comma separation. Specifying files will output their URL in the command line.
34+ The polyfill target and tests can be specified as arguments to the ` debug ` task.
35+ Example: ` grunt debug:web-animations-next:test/web-platform-tests/web-animations/animation/pause.html `
36+ Multiple test files may be listed with comma separation. Specifying files will output their URL in the command line.
2437Example: ` http://localhost:9876/base/test/web-platform-tests/web-animations/animation/pause.html `
2538
2639
@@ -46,7 +59,7 @@ Example: `http://localhost:9876/base/test/web-platform-tests/web-animations/anim
4659 Use the following to generate a summary of commits, but edit the list to contain only
4760 relevant information.
4861
49- git log --first-parent `git describe --tags --abbrev=0 web-animations-js/ master`..web-animations-next/master --pretty=format:" * %s"
62+ git log --first-parent `git describe --tags --abbrev=0 master`..dev --pretty=format:" * %s"
5063
51641 . Specify the new version inside ` package.json ` (for NPM), for example:
5265
@@ -56,7 +69,25 @@ Example: `http://localhost:9876/base/test/web-platform-tests/web-animations/anim
5669
57701. Build the polyfill with ` npm install && grunt` then update ` docs/experimental.md` ' s Build Target Comparison with the current gzipped sizes.
5871
59- 1. Submit both changes to web-animations-next then follow the procedure to push from web-animations-next to web-animations-js.
72+ 1. Commit the above changes to web-animations-js/dev and merge to
73+ web-animations-js/master.
74+
75+ ```sh
76+ git checkout master
77+ git merge dev --no-edit --quiet
78+ ```
79+
80+ 1. Build and commit minified JavaScript files.
81+
82+ ```sh
83+ npm install
84+ grunt
85+ # Optional "grunt test" to make sure everything still passes.
86+ git add -f *.min.js*
87+ git rm .gitignore
88+ git commit -m ' Add build artifacts from ' `cat .git/refs/heads/dev`
89+ git push HEAD:refs/heads/master
90+ ```
6091
61921. Draft a [new release](https://github.com/web-animations/web-animations-js/releases) at the
6293 commit pushed to web-animations-js in step #4. Copy the release notes from `History.md`
@@ -70,20 +101,6 @@ Example: `http://localhost:9876/base/test/web-platform-tests/web-animations/anim
70101
71102 Only owners of the group may post to it so you may need to request ownership or ask someone to post it for you.
72103
73- ## Pushing from web-animations-next to web-animations-js
74-
75- git fetch web-animations-next
76- git fetch web-animations-js
77- git checkout web-animations-js/master
78- git merge web-animations-next/master --no-edit --quiet
79- npm install
80- grunt
81- # Optional "grunt test" to make sure everything still passes.
82- git add -f *.min.js*
83- git rm .gitignore
84- git commit -m ' Add build artifacts from ' `cat .git/refs/remotes/web-animations-next/master`
85- git push web-animations-js HEAD:refs/heads/master
86-
87104## Testing architecture
88105
89106This is an overview of what happens when `grunt test` is run.
0 commit comments