Skip to content

Latest commit

 

History

History
58 lines (36 loc) · 1.45 KB

contributing.md

File metadata and controls

58 lines (36 loc) · 1.45 KB

Contributing to Mapnik Reference

We welcome contributions. Please provide pull requests and notify @springmeyer for review.

Changing index.js

Do not change index.js directly as it is generated. Modify index._ instead and run node generate.js instead. If the node binary is differently named on your operating system (e.g. nodejs) use that instead.

Releasing

  1. Create a milestone for the upcoming release
  • Assign tickets to it
  • Notify other contributors
  • Discuss, if needed, what the version # should be based on the types of changes anticipated
  1. If the version in package.json is not already updated for the new release:
  • Update the version
  • Do a bump commit
git commit -a -m "bump to v0.8.1"

Only bump the version when committing to master (not in pull requests).

  1. Update the datasources:

Run:

make

And commit the changes. This will edit the datasources.json based on the datasources.template.json.

  1. Make sure all tests are passing on travis: Build Status

  2. Ensure the changelog lists the upcoming version and details of what changed

  3. Tag the new version and upload to github

git tag -a v0.8.1 -m "tagging v0.8.1"
git push --tags
  1. Publish to npm

NOTE: make sure your git checkout is clean first: git status should show no changes or untracked files.

npm publish