For pull requests:
Be consistent with prevalent style and design decisions.
Add a Jasmine spec to
specs/q-spec.js.Use
npm testto avoid regressions.Run tests in
q-spec/run.htmlin as many supported browsers as you can find the will to deal with.Do not build minified versions; we do this each release.
If you would be so kind, add a note to
CHANGES.mdin an appropriate section:Next Major Versionif it introduces backward incompatibilities to code in the wild using documented features.Next Minor Versionif it adds a new feature.Next Patch Versionif it fixes a bug.
For releases:
Run
npm test.Run tests in
q-spec/run.htmlin a representative sample of every browser under the sun.Run
npm run coverand make sure you're happy with the results.Run
npm run minifyand be sure to commit the resultingq.min.js.Note the Gzipped size output by the previous command, and update
README.mdif it has changed to 1 significant digit.Stash any local changes.
Update
CHANGES.mdto reflect all changes in the differences betweenHEADand the previous tagged version. Give credit where credit is due.Update
README.mdto address all new, non-experimental features.Update the API reference on the Wiki to reflect all non-experimental features.
Use
npm version major|minor|patchto updatepackage.json, commit, and tag the new version.Use
npm publishto send up a new release.Send an email to the q-continuum mailing list announcing the new release and the notes from the change log. This helps folks maintaining other package ecosystems.