Thank you for your interest in contributing! Please feel free to put up a PR for any issue or feature request. :)
We want this community to be friendly and respectful to each other. Please follow these guidelines in all your interactions with the project.
We assume you have set up your React Native development tools. To run the example app in this repository, you will need React Native CLI tools. (The example is not managed by Expo tools.)
You will also need a Mapbox API access token, and must copy it into example/mapbox_token.json (see example/mapbox_token.json.example).
If you do not need to run the example app, you can use an arbitrary string instead of a token, which will at least allow the example app to build.
Run yarn bootstrap in the root directory to install the required dependencies for each package:
yarnWhile developing, you can run the example app to test your changes.
To start the packager for the example app:
yarn example startTo run the example app on Android:
yarn example android- To run an Android release build, add
--variant=releaseto the above command. - To run the app on a specific device, get the device ID from the output of
adb devices, then add--deviceId=$DEVICE_IDto the above command.
To run the example app on iOS:
yarn example iosMake sure your code passes TypeScript and ESLint. Run the following to verify:
yarn typescript
yarn lintTo fix formatting errors, run the following:
yarn lint --fixRemember to add tests for your change if possible. Run the unit tests by:
yarn testWe use the following commit message types:
Chore: small changes with minor importanceDocumentation: changes in documentation, e.g. add usage example for the module..Feature: new features, e.g. add new method to the module.Fix: small bug fixesRefactor: code refactor, e.g. migrate from class components to hooks.Style: code or output formatting changesTest: adding or updating testsCleanup: removing dead code or comments, reorganizing code (smaller thanRefactor)
Our pre-commit hooks verify that your commit message matches this format when committing.
We use TypeScript for type checking, ESLint with Prettier for linting and formatting the code, and Jest for testing.
Our pre-commit hooks verify that most of these checks pass when committing.
The package.json file contains various scripts for common tasks:
yarn bootstrap: setup project by installing all dependencies and pods.yarn typescript: type-check files with TypeScript.yarn lint: lint files with ESLint.yarn test: run unit tests with Jest.yarn docs: render documentation using Typedoc.yarn example start: start the Metro server for the example app.yarn example android: run the example app on Android.yarn example ios: run the example app on iOS.
When you're sending a pull request:
- Prefer small pull requests focused on one change.
- Verify that linters and tests are passing.
- Review the documentation to make sure it looks good.
- Follow the pull request template when opening a pull request.
- For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.
If you notice any bugs, see some code that could be improved, or have features you would like to see added, please create a bug report or feature request. Please select the issue template that suits your needs, and fill out the form that will be auto-created, to submit your request.
Please feel free to work on fixing any issue that is currently open. It is greatly appreciated if you create an issue before you start working on any problems you notice in the code, so that the solution can be discussed beforehand.
The following paths in the repository correspond to placeholder files that we may use for reference later if we choose to develop the associated features:
.circleci/
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our community include:
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community
Examples of unacceptable behavior include:
- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
Community Impact: A violation through a single incident or series of actions.
Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
Consequence: A permanent ban from any sort of public interaction within the community.
This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by Mozilla's code of conduct enforcement ladder.
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.