Skip to content

Commit 2031240

Browse files
author
Konrad Jamrozik
committed
update eng/README.md
1 parent 7194ba3 commit 2031240

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

eng/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ Below are code convention we strive to follow in `eng` directory:
1313
- We align `package.json` dependencies versions across all `package.json` files.
1414
- We align `package.json` dependencies numbers with [microsoft/typespec package.json].
1515
In few cases we allow more frequent update cadence.
16+
- We avoid doing package overrides. For example, we use `v8` of `eslint` instead of `v9` to avoid an override.
17+
[See this comment for details][eslint override].
18+
- We order `package.json` keys as follows: `name private type main bin scripts engines dependencies devDependencies`.
1619

1720
### package-lock.json
1821

@@ -30,3 +33,4 @@ Below are code convention we strive to follow in `eng` directory:
3033
[Design guidelines for spec repos validation tooling]: https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/1153/Design-guidelines-for-spec-repos-validation-tooling
3134
[microsoft/typespec package.json]: https://github.com/microsoft/typespec/blob/main/package.json
3235
[microsoft/typespec .prettierrc.json]: https://github.com/microsoft/typespec/blob/main/.prettierrc.json
36+
[eslint override]: https://github.com/Azure/azure-rest-api-specs/pull/29820#pullrequestreview-2177045580

0 commit comments

Comments
 (0)