-
Notifications
You must be signed in to change notification settings - Fork 26
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
16 changed files
with
52 additions
and
10,196 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 |
---|---|---|
@@ -1,27 +1,43 @@ | ||
# Contributing | ||
# Contributing to js-data core | ||
|
||
[Read the Contributing Guide](http://js-data.io/docs/contributing). | ||
[Read the general Contributing Guide](http://js-data.io/docs/contributing). | ||
|
||
## Support | ||
## Project structure | ||
|
||
[Find out how to Get Support](http://js-data.io/docs/support). | ||
* `dist/` - Contains final build files for distribution (js-data-http) | ||
* `doc/` - Output folder for JSDocs | ||
* `fetch/` - Contains js-data-fetch package files | ||
* `dist/` - Contains final build files for distribution (js-data-fetch) | ||
* `node/` - Contains js-data-http-node package files | ||
* `dist/` - Contains final build files for distribution (js-data-http-node) | ||
* `scripts/ - Various build scripts | ||
* `src/` - Project source code | ||
* `test/` - Project tests | ||
|
||
## Community | ||
## Clone, build & test | ||
|
||
[Explore the Community](http://js-data.io/docs/community). | ||
1. `clone [email protected]:js-data/js-data-http.git` | ||
1. `cd js-data-http` | ||
1. `npm install` | ||
1. `npm test` - Build and test | ||
|
||
### Have write access? | ||
|
||
To cut a release: | ||
## To cut a release | ||
|
||
1. Checkout master | ||
1. Bump version in `package.json` appropriately | ||
1. Run `npm run release` | ||
1. Update `CHANGELOG.md` appropriately | ||
1. Commit and push changes, including the `dist/` folder | ||
1. Run `npm run release` | ||
1. Commit and push changes | ||
1. Checkout `release`, merge `master` into `release` | ||
1. Run `npm run release` again | ||
1. Commit and push changes | ||
1. Make a GitHub release | ||
- tag from `release` branch | ||
- set tag name to version | ||
- set release name to version | ||
- set release body to changelog entry for the version | ||
- attach the files in the `dist/` folder | ||
- upload the files in the `dist/` folder | ||
1. `npm publish .` | ||
1. checkout `master` | ||
|
||
See also [Community & Support](http://js-data.io/docs/community). |
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 |
---|---|---|
@@ -1,3 +1,5 @@ | ||
dist/*.js | ||
dist/*.map | ||
bower_components/ | ||
|
||
.idea/ | ||
|
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
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
Oops, something went wrong.