doc: added allowlist docs to CONTRIBUTING.md (#4048)

aws · Mar 9, 2022 · 6d7d96c · 6d7d96c
1 parent a25e555
commit 6d7d96c
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -96,6 +96,18 @@ specific service, for example:
 AWS_REGION=[set region] node node_modules/cucumber/bin/cucumber.js --tag @s3
 ```
 
+Hardcoded region strings are not allowed in the SDK. To check the code for
+the presence of hardcoded region strings, run
+
+```
+node ./scripts/region-checker/index.js
+```
+
+from the project root directory. If this command shows any output, the PR will
+not be merged. Any lines that appear here must have the region string removed
+or be added to `scripts/region-checker/allowlist.js`. Lines should only be
+allowlisted if absolutely necessary.
+
 ### Testing the documentation changes:
 
 To test the documentation changes, please ensure you have the following requirements installed (Please make sure you have the latest version of Ruby):