Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1.6 KB

README.md

File metadata and controls

38 lines (29 loc) · 1.6 KB
Raw

expensify-common

This is a collection of JS/TS libraries and components which are used across various Expensify projects. These libraries are provided as-is, and the repos which use them will need to do their own bundling, minifying, and uglifying.

Installation

expensify-common is published to npm

npm install expensify-common

Development

  • Write all code as ES6.
  • Always lint your code with npm run lint

Testing your code while you are developing

The best way to test your code while you are developing changes is via npm link.

  1. Run npm link in the project root
  2. cd into the project directory that has a dependency on expensify-common
  3. Run npm link expensify-common

If that does not work, another option is running npm i expensify-common ../expensify-common --save.

Alternatively, you can edit files directly in a project's node_modules then apply those changes to this repository.

Proposing a Change (Non-Expensify Contributors)

  1. Fork this repository and create a new branch
  2. Open a PR to merge your changes
  3. An Expensify engineer will be automatically assigned to your PR
  4. They will review and accept your changes, merge them, then deploy a new version

Deploying a Change (Expensify Only)

Once the PR has been merged, install the new version of the package with npm install expensify-common@x.x.x command. Be sure to check the repos below to confirm whether or not they are affected by your changes!

  • Expensify/Web-Expensify
  • Expensify/Web-Secure
  • Expensify/Mobile-Expensify
  • Expensify/App
  • Expensify/Comp