Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: added allowlist docs to CONTRIBUTING.md #4048

Merged
merged 1 commit into from
Mar 9, 2022
Merged

doc: added allowlist docs to CONTRIBUTING.md #4048

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down