Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
37 lines (28 sloc) 992 Bytes

Contributing to js-data-firebase

Read the general Contributing Guide.

Project structure

  • dist/ - Contains final build files for distribution
  • doc/ - Output folder for JSDocs
  • src/ - Project source code
  • test/ - Project tests

Clone, build & test

  1. clone git@github.com:js-data/js-data-firebase.git
  2. cd js-data-firebase
  3. npm install
  4. npm test - Lint, 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
  1. npm publish .

See also Community & Support.