Hi, and thanks in advance for contributing to Mapbox React Examples. Here's how we work. Please follow these conventions when submitting an issue or pull request.
- Install Git and Node.js version >=18
- Fork this project
- Clone your new fork,
git clone git@github.com:GithubUser/mapbox-react-examples.git cd mapbox-react-examples
- Create a new branch
git checkout -b your-branchfor your contribution. - Write code, open a PR from your branch when you're ready.
- Notify our maintainer about your PR on Discord.
Make sure to not commit a working Access Token to avoid your key being stolen and causing unwanted charges. If you accidentally committed one, please "refresh" your token on the Mapbox Access Token panel.
There are many ways in which you can contribute to Mapbox React Examples.
Something's broken or not working anymore? Open an Issue, describe the bugs you encountered, and include details of your system like OS, Node.js version, and terminal.
We welcome all feature requests, whether it's to add new functionality to an existing example or to offer an idea for a brand new Mapbox React example.
We may forget to keep our docs up to date or include enough detail. You can help by suggesting improvements or fixing typos in our documentation.
Help make sure the examples are bug-free, efficient, and written in a React-y way. We also appreciate more React + Mapbox examples being created.