1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
|
## 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
2) If the version in `package.json` is not already updated for the new release:
- Update the version
- Do a bump commit
```bash
git commit -a -m "bump to v0.8.1"
```
Only bump the version when committing to master (not in pull requests).
3) Update the datasources:
Run:
```
make
```
And commit the changes. This will edit the `datasources.json` based on the `datasources.template.json`.
4) Make sure all tests are passing on travis: [](https://travis-ci.org/mapnik/mapnik-reference)
4) Ensure the changelog lists the upcoming version and details of what changed
5) Tag the new version and upload to github
```bash
git tag -a v0.8.1 -m "tagging v0.8.1"
git push --tags
```
6) Publish to npm
NOTE: make sure your git checkout is clean first: `git status` should show no changes or untracked files.
```bash
npm publish
```
|