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
+9-11Lines changed: 9 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,24 +6,23 @@ documentation, we greatly value feedback and contributions from our community.
6
6
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
7
7
information to effectively respond to your bug report or contribution.
8
8
9
-
10
9
## Reporting Bugs/Feature Requests
11
10
12
11
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
13
12
14
13
When filing an issue, please check [existing open](https://github.com/aws-solutions/distributed-load-testing-on-aws/issues), or [recently closed](https://github.com/aws-solutions/distributed-load-testing-on-aws/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
15
14
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
16
15
17
-
* A reproducible test case or series of steps
18
-
* The version of our code being used
19
-
* Any modifications you've made relevant to the bug
20
-
* Anything unusual about your environment or deployment
21
-
16
+
- A reproducible test case or series of steps
17
+
- The version of our code being used
18
+
- Any modifications you've made relevant to the bug
19
+
- Anything unusual about your environment or deployment
22
20
23
21
## Contributing via Pull Requests
22
+
24
23
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
25
24
26
-
1. You are working against the latest source on the *master* branch.
25
+
1. You are working against the latest source on the _main_ branch.
27
26
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
28
27
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
29
28
@@ -39,20 +38,19 @@ To send us a pull request, please:
39
38
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
40
39
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
41
40
42
-
43
41
## Finding contributions to work on
44
-
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws-solutions/distributed-load-testing-on-aws/labels/help%20wanted) issues is a great place to start.
45
42
43
+
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws-solutions/distributed-load-testing-on-aws/labels/help%20wanted) issues is a great place to start.
46
44
47
45
## Code of Conduct
46
+
48
47
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
49
48
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
50
49
opensource-codeofconduct@amazon.com with any additional questions or comments.
51
50
52
-
53
51
## Security issue notifications
54
-
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.
55
52
53
+
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.
Copy file name to clipboardExpand all lines: README.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ A NodeJS Lambda function for the API microservices. Integrated with Amazon API G
26
26
ReactJS Single page application to provide a GUI to the solutions. Authenticated through Amazon Cognito this dashboard allows users to Create tests and view the final results.
27
27
28
28
**source/custom-resource**<br/>
29
-
A NodeJS Lambda function used as a CloudFormation custom resource for sending anonymous metrics, configuration for regional testing infrastructure, and iot configuration.
29
+
A NodeJS Lambda function used as a CloudFormation custom resource for sending anonymized metrics, configuration for regional testing infrastructure, and iot configuration.
30
30
31
31
**source/infrastructure**<br/>
32
32
A Typescript [AWS Cloud Development Kit (AWS CDK)](https://aws.amazon.com/cdk/)[v2](https://docs.aws.amazon.com/cdk/v2/guide/home.html) package that defines the infrastructure resources to run the Distributed Load Testing on AWS solution.
@@ -105,6 +105,7 @@ chmod +x ./build-s3-dist.sh
105
105
> **Note**: The _build-s3-dist_ script expects the bucket name **without the region suffix** as one of its parameters.
106
106
107
107
- Deploy the distributable to the Amazon S3 bucket in your account.
108
+
108
109
- Make sure you are uploading the files in `deployment/global-s3-assets` and `deployment/regional-s3-assets` to `$BUCKET_NAME/$SOLUTION_NAME/$VERSION`.
109
110
110
111
- Get the link of the solution template uploaded to your Amazon S3 bucket.
@@ -118,8 +119,9 @@ For details on how to customize the container image, please see the **Container
118
119
119
120
## Collection of operational metrics
120
121
121
-
This solution collects anonymous operational metrics to help AWS improve the quality and features of the solution. For more information, including how to disable this capability, please see the [implementation guide](https://docs.aws.amazon.com/solutions/latest/distributed-load-testing-on-aws/operational-metrics.html).
122
-
***
122
+
This solution collects anonymized operational metrics to help AWS improve the quality and features of the solution. For more information, including how to disable this capability, please see the [implementation guide](https://docs.aws.amazon.com/solutions/latest/distributed-load-testing-on-aws/operational-metrics.html).
123
+
124
+
---
123
125
124
126
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.<br />
"header/header": ["error", "line", [" Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.", " SPDX-License-Identifier: Apache-2.0"], 2],
57
+
"header/header": [
58
+
"error",
59
+
"line",
60
+
[" Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.", " SPDX-License-Identifier: Apache-2.0"],
61
+
2
62
+
],
55
63
56
64
"jsdoc/require-param-type": ["off"],
57
65
"jsdoc/require-returns-type": ["off"],
58
66
"jsdoc/newline-after-description": ["off"],
59
67
60
68
"import/no-unresolved": 1 // warn only on Unable to resolve path import/no-unresolved
0 commit comments