Skip to content

Commit

Permalink
Merge pull request #110 from Expensify/monil-updateReadMe
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
carlosmiceli authored Aug 1, 2024
2 parents 61b6efd + c1ba8d7 commit 861e29f
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,14 @@ This package provides Expensify's .eslintrc as an extensible shared config. Most

## How to Develop

1. Make a change
2. Bump the version in package.json and submit your PR

1. You only need to make a PR with the changes. There is no need to bump the version in `package.json` file in your PR. A github action will automatically bump the version and publish the package to npm after PR is merged.
`
### Testing

After you have submitted a PR with an updated version in the `package.json` file,
After you have submitted a PR,

1. Get the full commitID of the last commit in your PR, and run `npm install git+https://github.com/Expensify/eslint-config-expensify.git#COMMIT_ID` in the repo against which you want to test those changes.
2. This should update the version of `eslint-config-expensify` in `package-lock.json` file, and ensures the repo is referencing to the correct version of the eslint config.
2. This should update the resolved path of `eslint-config-expensify` in `package-lock.json` file, and ensures the repo is referencing to the correct local version of the eslint config.
3. Now, you can run `npm run lint` or perform any other tests you want in that repo.

### After PR is merged
Expand Down

0 comments on commit 861e29f

Please sign in to comment.