diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 11d5f69a9d..c13607c3db 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,6 +7,7 @@ Please read through this document before submitting any issues or pull requests information to effectively respond to your bug report or contribution. ## Security issue notifications + If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue. ## Reporting Bugs/Feature Requests @@ -35,7 +36,7 @@ Contributions via pull requests are much appreciated. Before sending us a pull r To send us a pull request, please follow these steps: 1. Fork the repository. -2. Install dependencies: `npm install` +2. Install dependencies: `npm ci` 3. Prepare utilities like commit hooks: `npm run init-environment` 4. Create a new branch to focus on the specific change you are contributing e.g. `git checkout -b improv/logger-debug-sampling` 5. Run all tests, and code baseline checks: `npm run test` @@ -54,8 +55,9 @@ You might find useful to run both the documentation website and the API referenc * **Docs website**: You can build and start a local docs website by running these two commands. - - `npm run docs-buildDockerImage` OR `docker build -t squidfunk/mkdocs-material ./docs/` - - `npm run docs-runLocalDocker` OR `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material` + +* `npm run docs-buildDockerImage` OR `docker build -t squidfunk/mkdocs-material ./docs/` +* `npm run docs-runLocalDocker` OR `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material` ### Conventions @@ -89,4 +91,4 @@ TODO See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. -We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes. \ No newline at end of file +We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes. diff --git a/packages/commons/tsconfig.json b/packages/commons/tsconfig.json index cbd9922f32..460e4ec937 100644 --- a/packages/commons/tsconfig.json +++ b/packages/commons/tsconfig.json @@ -1,5 +1,6 @@ { "compilerOptions": { + "composite": true, "experimentalDecorators": true, "noImplicitAny": true, "target": "ES2020", diff --git a/packages/logger/tsconfig.json b/packages/logger/tsconfig.json index 20da6e39a9..8c88af047a 100644 --- a/packages/logger/tsconfig.json +++ b/packages/logger/tsconfig.json @@ -26,5 +26,10 @@ "types": [ "jest", "node" + ], + "references": [ + { + "path": "../commons" + } ] } \ No newline at end of file diff --git a/packages/metrics/tsconfig.json b/packages/metrics/tsconfig.json index 582618277f..de7412a5c3 100644 --- a/packages/metrics/tsconfig.json +++ b/packages/metrics/tsconfig.json @@ -28,5 +28,10 @@ "types": [ "jest", "node" + ], + "references": [ + { + "path": "../commons" + } ] } \ No newline at end of file diff --git a/packages/tracing/tsconfig.json b/packages/tracing/tsconfig.json index 8b93f8c299..723ebdaf7e 100644 --- a/packages/tracing/tsconfig.json +++ b/packages/tracing/tsconfig.json @@ -28,5 +28,10 @@ "types": [ "jest", "node" + ], + "references": [ + { + "path": "../commons" + } ] } \ No newline at end of file