Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING.md #292

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Update CONTRIBUTING.md #292

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e94f008
Update CONTRIBUTING.md
stepankuzmin Dec 8, 2022
533fe78
Update CONTRIBUTING.md
stepankuzmin Dec 8, 2022
68357b6
Merge branch 'master' into stepankuzmin-patch-1
stepankuzmin Dec 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Developing

yarn install & yarn start & open http://localhost:9966/example/
npm install && npm start && open http://localhost:9966/

You'll need a [Mapbox access token](https://www.mapbox.com/help/create-api-access-token/) stored in localstorage. Set it via

Expand All @@ -10,16 +10,16 @@ You'll need a [Mapbox access token](https://www.mapbox.com/help/create-api-acces

Tests require an MapboxAccessToken env variable to be set.

export MapboxAccessToken=<YOUR ACCESS TOKEN> && yarn test
MapboxAccessToken=<YOUR ACCESS TOKEN> npm test

### Release process

1. `git checkout master`
1. `git pull --rebase --autostash` to ensure you have the latest changes.
1. `export MapboxAccessToken=<YOUR ACCESS TOKEN> && npm test`
1. `MapboxAccessToken=<YOUR ACCESS TOKEN> npm test`
1. Update [`CHANGELOG.md`](https://github.com/mapbox/mapbox-gl-directions/blob/master/CHANGELOG.md)
1. `npm version {major|minor|patch}`
1. Create a release branch off of master that updates `CHANGELOG.md` and increments `package.json`.
1. `git push --follow-tags`
1. `mbx npm publish`
1. Update version number on [GL JS example page](https://github.com/mapbox/mapbox-gl-js/blob/mb-pages/docs/_posts/examples/3400-01-11-mapbox-gl-directions.html)
1. Update version number on [GL JS example page](https://docs.mapbox.com/mapbox-gl-js/example/mapbox-gl-directions/)