Skip to content

Commit 4e48b6b

Browse files
committed
Add guidance on getting help and opening issues to README.md
1 parent 66c7296 commit 4e48b6b

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,27 @@ There are a few known limitations with the bundled TypeScript definitions at thi
107107
* Service client typings reflect the latest `apiVersion`, regardless of which `apiVersion` is specified when creating a client.
108108
* Service-bound parameters use the `any` type.
109109

110+
## Getting Help
111+
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.
112+
* Ask a question on [StackOverflow](https://stackoverflow.com/) and tag it with `aws-sdk-js`
113+
* Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js?source=orgpage)
114+
* Open a support ticket with [AWS Support](https://console.aws.amazon.com/support/home#/)
115+
* If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js/issues/new)
116+
117+
## Opening Issues
118+
If you encounter a bug with the AWS SDK for JavaScript we would like to hear
119+
about it. Search the [existing issues](https://github.com/aws/aws-sdk-js/issues)
120+
and try to make sure your problem doesn’t already exist before opening a new
121+
issue. It’s helpful if you include the version of the SDK, Node.js or browser
122+
environment and OS you’re using. Please include a stack trace and reduced repro
123+
case when appropriate, too.
124+
125+
The GitHub issues are intended for bug reports and feature requests. For help
126+
and questions with using the AWS SDK for JavaScript please make use of the
127+
resources listed in the [Getting Help](https://github.com/aws/aws-sdk-js#getting-help)
128+
section. There are limited resources available for handling issues and by
129+
keeping the list of open issues lean we can respond in a timely manner.
130+
110131
## Supported Services
111132

112133
<p class="note"><strong>Note</strong>:

0 commit comments

Comments
 (0)