You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-6Lines changed: 4 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,6 @@ Please read through this document before submitting any issues or pull requests
7
7
information to effectively respond to your bug report or contribution.
8
8
9
9
## Security issue notifications
10
-
11
10
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.
12
11
13
12
## Reporting Bugs/Feature Requests
@@ -36,7 +35,7 @@ Contributions via pull requests are much appreciated. Before sending us a pull r
36
35
To send us a pull request, please follow these steps:
37
36
38
37
1. Fork the repository.
39
-
2. Install dependencies: `npm ci`
38
+
2. Install dependencies: `npm install`
40
39
3. Prepare utilities like commit hooks: `npm run init-environment`
41
40
4. Create a new branch to focus on the specific change you are contributing e.g. `git checkout -b improv/logger-debug-sampling`
42
41
5. Run all tests, and code baseline checks: `npm run test`
@@ -55,9 +54,8 @@ You might find useful to run both the documentation website and the API referenc
55
54
***Docs website**:
56
55
57
56
You can build and start a local docs website by running these two commands.
58
-
59
-
*`npm run docs-buildDockerImage` OR `docker build -t squidfunk/mkdocs-material ./docs/`
60
-
*`npm run docs-runLocalDocker` OR `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`
57
+
-`npm run docs-buildDockerImage` OR `docker build -t squidfunk/mkdocs-material ./docs/`
58
+
-`npm run docs-runLocalDocker` OR `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`
61
59
62
60
### Tests
63
61
@@ -181,4 +179,4 @@ TODO
181
179
182
180
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
183
181
184
-
We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
182
+
We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
0 commit comments