Skip to content

Latest commit

 

History

History
43 lines (35 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

43 lines (35 loc) · 1.31 KB

Contributing to js-data core

Read the general Contributing Guide.

Project structure

  • 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

Clone, build & test

  1. clone git@github.com:js-data/js-data-http.git
  2. cd js-data-http
  3. npm install
  4. npm test - Build and test

To cut a release

  1. Checkout master
  2. Bump version in package.json appropriately
  3. Update CHANGELOG.md appropriately
  4. Run npm run release
  5. Commit and push changes
  6. Checkout release, merge master into release
  7. Run npm run release again
  8. Commit and push changes
  9. 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
  • upload the files in the dist/ folder
  1. npm publish .
  2. checkout master

See also Community & Support.