1 | |
---|
2 | For pull requests: |
---|
3 | |
---|
4 | - Be consistent with prevalent style and design decisions. |
---|
5 | - Add a Jasmine spec to `specs/q-spec.js`. |
---|
6 | - Use `npm test` to avoid regressions. |
---|
7 | - Run tests in `q-spec/run.html` in as many supported browsers as you |
---|
8 | can find the will to deal with. |
---|
9 | - Do not build minified versions; we do this each release. |
---|
10 | - If you would be so kind, add a note to `CHANGES.md` in an |
---|
11 | appropriate section: |
---|
12 | |
---|
13 | - `Next Major Version` if it introduces backward incompatibilities |
---|
14 | to code in the wild using documented features. |
---|
15 | - `Next Minor Version` if it adds a new feature. |
---|
16 | - `Next Patch Version` if it fixes a bug. |
---|
17 | |
---|
18 | For releases: |
---|
19 | |
---|
20 | - Run `npm test`. |
---|
21 | - Run tests in `q-spec/run.html` in a representative sample of every |
---|
22 | browser under the sun. |
---|
23 | - Run `npm run cover` and make sure you're happy with the results. |
---|
24 | - Run `npm run minify` and be sure to commit the resulting `q.min.js`. |
---|
25 | - Note the Gzipped size output by the previous command, and update |
---|
26 | `README.md` if it has changed to 1 significant digit. |
---|
27 | - Stash any local changes. |
---|
28 | - Update `CHANGES.md` to reflect all changes in the differences |
---|
29 | between `HEAD` and the previous tagged version. Give credit where |
---|
30 | credit is due. |
---|
31 | - Update `README.md` to address all new, non-experimental features. |
---|
32 | - Update the API reference on the Wiki to reflect all non-experimental |
---|
33 | features. |
---|
34 | - Use `npm version major|minor|patch` to update `package.json`, |
---|
35 | commit, and tag the new version. |
---|
36 | - Use `npm publish` to send up a new release. |
---|
37 | - Send an email to the q-continuum mailing list announcing the new |
---|
38 | release and the notes from the change log. This helps folks |
---|
39 | maintaining other package ecosystems. |
---|
40 | |
---|