forked from wizardwerdna/q
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
48 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
|
||
For pull requests: | ||
|
||
- Be consistent with prevelant style and design decisions. | ||
- Add a Jasmine spec to `specs/q-spec.js`. | ||
- Use `npm test` to avoid regressions. | ||
- Run tests in `q-spec/run.html` in as many supported browsers as you | ||
can find the will to deal with. | ||
- You do not need to build minified versions. | ||
- If you would be so kind, add a note to `CHANGES.md` in an | ||
appropriate section: | ||
|
||
- `Next Major Version` if it introduces backward incompatibilities | ||
to code in the wild using documented features. | ||
- `Next Minor Version` if it adds a new feature. | ||
- `Next Patch Version` if it fixes a bug. | ||
|
||
For releases: | ||
|
||
- Run `npm test`. | ||
- Run tests in `q-spec/run.html` in a representative sample of every | ||
browser under the sun. | ||
- Run `npm run cover` and make sure you're happy with the results. | ||
- Arrange for the Google Closure Compiler to be available as a | ||
`closure` command then run `source minify` to build `q.min.js` and | ||
`q.min.js.gz` and commit with `Minify`. | ||
|
||
```bash | ||
#!/bin/bash | ||
java -jar `which closure.jar` $@ | ||
``` | ||
|
||
- Note the size of `q.min.js.gz` in `README.md` if it has changed to 1 | ||
significant digit. | ||
- Stash any local changes. | ||
- Update `CHANGES.md` to reflect all changes in the differences | ||
between `HEAD` and the previous tagged version. Give credit where | ||
credit is due. | ||
- Update `README.md` to address all new, non-expiermental features. | ||
- Update the API reference on the Wiki to reflect all non-expiermental | ||
features. | ||
- Use `npm version major|minor|patch` to update `package.json`, | ||
commit, and tag the new version. | ||
- Use `npm publish` to 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. | ||
|