Hi, and thanks in advance for contributing to Mapbox GL. Here's how we work. Please follow these conventions when submitting an issue or pull request.
When reporting a bug, if possible please include executable code that demonstrates the issue you have encountered. A good way to do so is to attach a link to an example on JSFiddle.
- Our code conventions are mostly enforced with eslint, which will be run as part of
npm test. - In internal / private methods, we check preconditions with
assert, helping us catch mistakes within the library. For performance, these checks are removed from the production build with unassertify. - In external / public methods, we check preconditions where appropriate and emit an error. "Emit" can mean throwing an
Error, passing anErroras a first callback argument, or emitting anerrorevent, as appropriate for the context. These checks remain present in production builds, helping downstream authors avoid common mistakes.
See docs/README.md.
If you have commit access to the repository, please be aware that we strive to maintain a clean, mostly-linear history. When merging a branch, please do the following:
- Rebase the branch onto the current tip of the target branch (
masterormb-pages). - Squash commits until they are self-contained, potentially down to a single commit if appropriate.
- Perform a fast-forward merge into the target branch and push the result.
In particular do not use the "Merge pull request" button on GitHub.
This applies when merging pull-requests from external contributors as well. If necessary, rebase and clean up the commits yourself before manually merging them. Then comment in the PR thanking the contributor and noting the final commit hash(es), and close it.
Never merge a branch that is failing CI.