diff --git a/docs/CodingGuidelines.md b/docs/CodingGuidelines.md index b0e9a5c55..8905fbd61 100644 --- a/docs/CodingGuidelines.md +++ b/docs/CodingGuidelines.md @@ -6,11 +6,14 @@ Guidelines that code authors and code reviewers are expected to adhere to in the ## Table of contents -- [Components](#components) -- [Code Style](#code-style) -- [Documentation](#documentation) -- [Pull Requests](#pull-requests) -- [Tests](#tests) +- [Coding guidelines](#coding-guidelines) + - [Table of contents](#table-of-contents) + - [Components](#components) + - [Code style](#code-style) + - [Documentation](#documentation) + - [Pull requests](#pull-requests) + - [Tests](#tests) + - [Packages](#packages) --- @@ -214,4 +217,16 @@ Guidelines that code authors and code reviewers are expected to adhere to in the it(“button dispatches onClick event”) ``` -- Tests should, at minimum, cover all core feature use-cases and identifiable edge-cases or boundary conditions. \ No newline at end of file +- Tests should, at minimum, cover all core feature use-cases and identifiable edge-cases or boundary conditions. + +## Packages + +- Packages in the monorepo each represent a publishable, standalone functionality. +- To ensure new packages are published to NPM, add a corresponding GitHub action step to `.github/workflows/npm-publish.yml`. +``` + - name: Publish {MY PACKAGE NAME} + uses: JS-DevTools/npm-publish@v1 + with: + package: './packages/{MY PACKAGE PATH}/package.json' + token: ${{ secrets.NPM_TOKEN }} +``` \ No newline at end of file diff --git a/package.json b/package.json index a7a46b5c1..dc4a3ffa4 100755 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "repository": "git@github.com:awslabs/iot-app-kit.git", "engines": { "node": ">=16.0.0", - "npm": ">=8.0.0" + "npm": ">=8.5.0" }, "workspaces": { "packages": [