Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(expo): Outline manual dependency sync process #1115

Merged
merged 4 commits into from
Oct 28, 2020

Conversation

bengourley
Copy link
Contributor

Goal

Document the process so that engineers without prior knowledge of the project's nuances can successfully keep Expo deps in sync.

Design

Keeping it simple and local to the project, and subject to the same review process for changes/updates.

Changeset

Added a CONTRIBUTING.md to the @bugsnag/expo package.

Testing

N/A

@bugsnagbot
Copy link
Collaborator

bugsnagbot commented Oct 28, 2020

@bugsnag/browser bundle size diff

Minified Minfied + Gzipped
Before 40.57 kB 12.52 kB
After 40.57 kB 12.52 kB
± No change No change

Generated by 🚫 dangerJS against f375f69


## Updating the CLI to install a compatible notifier version

When the version of the bundled native modules changes, making the notifier incompatible with previous Expo SDKs we need to update the CLI using the established pattern. See `packages/expo-cli/commands/install.js` for details.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I initially read this as "When the version of the bundled native modules changes, the notifier might be incompatible with previous Expo SDKs", when I think it means "When the version of the bundled native modules changes, the notifier will be incompatible with previous Expo SDKs"

Something like this might be clearer?

Suggested change
When the version of the bundled native modules changes, making the notifier incompatible with previous Expo SDKs we need to update the CLI using the established pattern. See `packages/expo-cli/commands/install.js` for details.
When the version of the bundled native modules changes the notifier will be incompatible with previous Expo SDKs. To prevent installing the conflicting versions, we need to update the CLI using the established pattern in [`packages/expo-cli/commands/install.js`](../expo-cli/commands/install.js).

bengourley and others added 3 commits October 28, 2020 10:08
Co-authored-by: Joe Haines <hello@joehaines.co.uk>
…ag/bugsnag-js into bengourley/expo-contributing-guide
@bengourley
Copy link
Contributor Author

Mergining in spite of CI failure. This was due to an issue that is now fixed in #1116. This PR only contains a markdown file.

@bengourley bengourley merged commit 55dac5d into next Oct 28, 2020
@bengourley bengourley deleted the bengourley/expo-contributing-guide branch October 28, 2020 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants