You can contribute to Expo development tools in various ways, including:
- Reporting bugs or issues on GitHub. Please make sure to include fill in all the details in the issue template to make sure the issue can be addressed as quickly as possible.
- Submitting improvements to the documentation. Updates, enhancements, new guides, spelling fixes...
- Helping other people on the forums.
- Looking at existing issues and adding more information, particularly helping to reproduce the issues.
- Submitting a pull request with a bug fix or an improvement.
The master branch of the repository should be kept releasable at any time. This way we can continuously deploy fixes and improvements without costly managing of different branches and issues will be noticed and fixed quickly. This also ensures other contributors can check out the latest version from GitHub and work on it with minimal disruption from other features in progress.
Keeping the master releasable means that changes merged to it need to be:
- Backwards compatible: Expo CLI should work with every currently supported Expo SDK version. If the code you're adding depends on a feature only present in newer or unreleased SDK versions, it needs to check which SDK version is being used and not assume the latest version is being used.
- Non-breaking: If code that is unreleasable or fails the test suite ends up in
master, it should be reverted. - Tested: Always include a test plan in pull requests. Do not merge code that doesn't pass all automated tests.
- Clone the repository.
- Run
yarn run bootstrap. (Installs dependencies, links and builds packages.) - Run
git config commit.template .github/.COMMIT_TEMPLATE(Sets you up with our commit message template)
You can then run yarn start in the root folder to start watching and automatically re-building packages when there are new changes.
To submit a pull request:
- Fork the repository and create a feature branch. (Existing contributors can create feature branches without forking. Prefix the branch name with
@your-github-username/.) - Write the description of your pull request. Make sure to include a test plan and test your changes.
- Make sure all tests pass on CircleCI.
- Wait for a review and adjust the code if necessary.
To publish a new release, run this command (you must have two-factor authentication enabled for npm):
node ./scripts/publish.js
The command will bump the versions of all packages with changes since the previous release and publish them in the correct order. For each changed package, it will ask, if the changes require a new major version (breaking changes), minor version (new backwards compatible functionality) or just a patch version (backwards compatible bug fixes).
If you wish to publish a canary version, please run:
yarn run publish --canary