CONTRIBUTING.md (4045B)
1 # Contributing to the AWS SDK for JavaScript
2
3 We work hard to provide a high-quality and useful SDK, and we greatly value
4 feedback and contributions from our community. Whether it's a bug report,
5 new feature, correction, or additional documentation, we welcome your issues
6 and pull requests. Please read through this document before submitting any
7 issues or pull requests to ensure we have all the necessary information to
8 effectively respond to your bug report or contribution.
9
10
11 ## Filing Bug Reports
12
13 You can file bug reports against the SDK on the [GitHub issues][issues] page.
14
15 If you are filing a report for a bug or regression in the SDK, it's extremely
16 helpful to provide as much information as possible when opening the original
17 issue. This helps us reproduce and investigate the possible bug without having
18 to wait for this extra information to be provided. Please read the following
19 guidelines prior to filing a bug report.
20
21 1. Search through existing [issues][] to ensure that your specific issue has
22 not yet been reported. If it is a common issue, it is likely there is
23 already a bug report for your problem.
24
25 2. Ensure that you have tested the latest version of the SDK. Although you
26 may have an issue against an older version of the SDK, we cannot provide
27 bug fixes for old versions. It's also possible that the bug may have been
28 fixed in the latest release.
29
30 3. Provide as much information about your environment, SDK version, and
31 relevant dependencies as possible. For example, let us know what version
32 of Node.js you are using, or if it's a browser issue, which browser you
33 are using. If the issue only occurs with a specific dependency loaded,
34 please provide that dependency name and version.
35
36 4. Provide a minimal test case that reproduces your issue or any error
37 information you related to your problem. We can provide feedback much
38 more quickly if we know what operations you are calling in the SDK. If
39 you cannot provide a full test case, provide as much code as you can
40 to help us diagnose the problem. Any relevant information should be provided
41 as well, like whether this is a persistent issue, or if it only occurs
42 some of the time.
43
44
45 ## Submitting Pull Requests
46
47 We are always happy to receive code and documentation contributions to the SDK.
48 Please be aware of the following notes prior to opening a pull request:
49
50 1. The SDK is released under the [Apache license][license]. Any code you submit
51 will be released under that license. For substantial contributions, we may
52 ask you to sign a [Contributor License Agreement (CLA)][cla].
53
54 2. If you would like to implement support for a significant feature that is not
55 yet available in the SDK, please talk to us beforehand to avoid any
56 duplication of effort.
57
58 ### Testing
59
60 To run the tests locally, install `phantomjs`. You can do so using [Homebrew][homebrew]:
61
62 ```
63 brew install phantomjs
64 ```
65
66 Then, to run all tests:
67
68 ```
69 npm test
70 ```
71
72 To run a particular test subset e.g. just the unit tests:
73
74 ```
75 npm run-script unit
76 ```
77
78 See the implementation of the `test` script in `package.json` for more options.
79
80 ### Changelog
81
82 We have moved to using a changelog to document changes between SDK versions instead of [release notes][releasenotes].
83 The release notes generally contained service client updates, and major SDK changes.
84 Our goal with the changelog is to document all changes made with each version of the SDK.
85 When submitting a pull request, please run the `add-change` script and commit the resulting JSON file so that your change gets added to the changelog.
86 From SDK root:
87 ```
88 node ./scripts/changelog/add-change.js
89 ```
90
91 See the [add-change cli notes](./scripts/changelog/README.md) for more information.
92
93 [issues]: https://github.com/aws/aws-sdk-js/issues
94 [pr]: https://github.com/aws/aws-sdk-js/pulls
95 [license]: http://aws.amazon.com/apache2.0/
96 [cla]: http://en.wikipedia.org/wiki/Contributor_License_Agreement
97 [homebrew]: http://brew.sh/
98 [releasenotes]: https://aws.amazon.com/releasenotes/JavaScript