Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (30 loc) · 2.1 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 2.1 KB

Contributing to Expo Orbit

📦 Download and Setup

  1. Fork this repository to your own GitHub account and then clone it to your local device. (git remote add upstream git@github.com:expo/orbit.git 😉)
  2. Make sure you have the following packages globally installed on your system:
    • node (node 12 or higher is recommended)
    • yarn
  3. Install the Node packages (yarn install)
  4. Build common-types, eas-shared and cli by running yarn build at the root of the project
  5. Inside the apps/cli directory run yarn archive to generate the standalone executable used by the menu-bar
  6. Finally, run yarn update-cli inside the apps/menu-bar directory to update the local cli file

🏎️ Start the Development environment

  1. From the apps/cli directory run yarn start to start Metro Bundler
  2. Run yarn macos to build the menu-bar app with Xcode
  3. And Orbit should automatically show up in your menu bar.

📝 Writing a Commit Message

If this is your first time committing to a large public repo, you could look through this neat tutorial: "How to Write a Git Commit Message"

Commit messages are formatted like so: [menu-bar] Title. Examples:

[cli] Fix typo in xxx
[devices-manager] Add test-case for custom devices
[menu-bar] Update loading icon

🔎 Before Submitting a PR

To help keep CI green, please make sure of the following:

  • Run yarn lint --fix to fix the formatting of the code. Ensure that yarn lint succeeds without errors or warnings.

📚 Additional Resources

Hungry for more, check out these great guides: