Skip to content

Commit

Permalink
chore: Add a note to the README for lint change
Browse files Browse the repository at this point in the history
  • Loading branch information
akash1810 committed May 19, 2021
1 parent 9da786b commit cad2bf9
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions integration-test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,14 @@ The purpose of this is to ensure:
This is in reaction to [#356](https://github.com/guardian/cdk/pull/356) and [#365](https://github.com/guardian/cdk/pull/365) which broke the package.
The integration test helps increase confidence in any future changes to the library, _before_ publishing them.
That is, the feedback loop is shortened.

## A note about linting
As we're not using a lockfile, our dependency versions are non-deterministic.

This means we can install versions of eslint plugins with updated rules that cause the project to fail the lint check.

Rather than [firefight](https://github.com/guardian/cdk/pull/564) this, we're simply not linting this project as:
- This project is never consumed by anyone
- This project doesn't run anywhere
- This project doesn't get updated too often
- Understanding the original lockfile issues is a time sink

0 comments on commit cad2bf9

Please sign in to comment.