Skip to content

Commit 6d7d96c

Browse files
authored
doc: added allowlist docs to CONTRIBUTING.md (#4048)
1 parent a25e555 commit 6d7d96c

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTING.md

+12
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,18 @@ specific service, for example:
9696
AWS_REGION=[set region] node node_modules/cucumber/bin/cucumber.js --tag @s3
9797
```
9898

99+
Hardcoded region strings are not allowed in the SDK. To check the code for
100+
the presence of hardcoded region strings, run
101+
102+
```
103+
node ./scripts/region-checker/index.js
104+
```
105+
106+
from the project root directory. If this command shows any output, the PR will
107+
not be merged. Any lines that appear here must have the region string removed
108+
or be added to `scripts/region-checker/allowlist.js`. Lines should only be
109+
allowlisted if absolutely necessary.
110+
99111
### Testing the documentation changes:
100112

101113
To test the documentation changes, please ensure you have the following requirements installed (Please make sure you have the latest version of Ruby):

0 commit comments

Comments
 (0)