Skip to content

Latest commit

 

History

History
101 lines (65 loc) · 6.5 KB

CONTRIBUTING.md

File metadata and controls

101 lines (65 loc) · 6.5 KB
Raw

Contributing

This document should cover most topics surrounding contributing to this repo.

Reporting issues

Are you having trouble getting started? Please contact us directly for assistance with integrating Bugsnag into your application. If you have spotted a problem with this module, feel free to open a new issue. Here are a few things to check before doing so:

  • Are you using the latest version of Bugsnag? If not, does updating to the latest version fix your issue?
  • Has somebody else already reported your issue? Feel free to add additional context to or check-in on an existing issue that matches your own.
  • Is your issue caused by this module? Only things related to @bugsnag/expo (including @bugsnag/plugin-* plugins to support various frameworks) should be reported here. For anything else, please contact us directly and we'd be happy to help you out.

Fixing issues

If you've identified a fix to a new or existing issue, we welcome contributions! Here are some helpful suggestions on contributing that help us merge your PR quickly and smoothly:

  • Fork the library on GitHub
  • Build and test your changes. We have automated tests for many scenarios but its also helpful to use npm pack to build the module locally and install it in a real app.
  • Commit and push until you are happy with your contribution
  • Make a pull request
  • Ensure the automated checks pass (and if it fails, please try to address the cause)

Adding features

Unfortunately we’re unable to accept PRs that add features or refactor the library at this time. However, we’re very eager and welcome to hearing feedback about the library so please contact us directly to discuss your idea, or open a feature request to help us improve the library.

Here’s a bit about our process designing and building the Bugsnag libraries:

  • We have an internal roadmap to plan out the features we build, and sometimes we will already be planning your suggested feature!
  • Our open source libraries span many languages and frameworks so we strive to ensure they are idiomatic on the given platform, but also consistent in terminology between platforms. That way the core concepts are familiar whether you adopt Bugsnag for one platform or many.
  • Finally, one of our goals is to ensure our libraries work reliably, even in crashy, multi-threaded environments. Oftentimes, this requires an intensive engineering design and code review process that adheres to our style and linting guidelines.

Supporting new Expo SDK versions

Updating the CLI to install a compatible notifier version

When a new Expo SDK is released, a new matching @bugsnag/expo version needs to be published. For example, for SDK 48 there is a @bugsnag/expo v48. To mark the new SDK as supported, update the CLI's LATEST_SUPPORTED_EXPO_SDK in packages/expo-cli/lib/version-information.js.

For details on how to release a new version, please see the release document.

Keeping dependencies in sync

The Expo notifier depends on some modules whose native code, if it exists, is bundled with Expo core. That means the version we depend on must match, otherwise we get conflicts and/or there are native/JS interface differences.

When a new version of the Expo SDK is released, the dependencies we use must be checked to see if they are up to date.

The following modules are currently used:

  • @react-native-community/netinfo (@bugsnag/delivery-expo, @bugsnsag/plugin-expo-connectivity-breadcrumbs)
  • expo-application (@bugsnag/plugin-expo-app)
  • expo-constants (@bugsnag/expo, @bugsnag/plugin-expo-app, @bugsnag/plugin-expo-device)
  • expo-crypto (@bugsnag/delivery-expo)
  • expo-device (@bugsnag/plugin-expo-device)
  • expo-file-system (@bugsnag/delivery-expo)
  • expo-secure-store (@bugsnag/plugin-expo-device)

If you add a new dependency please add it to this list.

To check what native module versions are bundled with Expo, check this file:

https://github.com/expo/expo/blob/main/packages/expo/bundledNativeModules.json

Additionally, @bugsnag/expo has a dependency on promise that must resolve to the same version used by react-native to ensure that we attach our unhandled rejection handler to the same instance of promise used by react-native.

Creating a new example app

This repository includes an example app for each supported version in the /examples directory. Please initialise a barebones app in this directory using the official expo tools, and remove versions no longer supported. We support the current version of expo and the last 2 major versions.

System requirements

In order to develop on the project you’ll need to be on Mac/Linux٭. You’ll need:

If you want to run the end-to-end tests locally you'll need Docker (including Docker Compose), and the AWS CLI. Note that you'll also need some BrowserStack and AWS credentials which are only available to Bugsnag employees.

Testing

A full guide to testing can be found in the testing document

CI

CI runs on Buildkite. Tests are run automatically on any branch from within this repo. PRs from external repos do not run on the private test infrastructure. Once an external PR has been reviewed by a Bugsnag employee, a branch can be created within this repo in order to run on CI.

⚠️ Caution: exercise due-diligence before creating a branch based on an external contribution

Releasing

A full guide to releases can be found in the release document