|
1 | | -Contributing to the AWS SDK for Go |
| 1 | +# Contributing to the AWS SDK for Go |
2 | 2 |
|
| 3 | +Thank you for your interest in contributing to the AWS SDK for Go! |
3 | 4 | We work hard to provide a high-quality and useful SDK, and we greatly value |
4 | 5 | feedback and contributions from our community. Whether it's a bug report, |
5 | 6 | new feature, correction, or additional documentation, we welcome your issues |
6 | 7 | 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 | +[issues][] or [pull requests][pr] to ensure we have all the necessary information to |
8 | 9 | effectively respond to your bug report or contribution. |
9 | 10 |
|
| 11 | +Jump To: |
10 | 12 |
|
11 | | -## Filing Bug Reports |
| 13 | +* [Bug Reports](_#Bug-Reports_) |
| 14 | +* [Feature Requests](_#Feature-Requests_) |
| 15 | +* [Code Contributions](_#Code-Contributions_) |
| 16 | + |
| 17 | +## How to contribute |
| 18 | + |
| 19 | +*Before you send us a pull request, please be sure that:* |
| 20 | + |
| 21 | +1. You're working from the latest source on the master branch. |
| 22 | +2. You check existing open, and recently closed, pull requests to be sure |
| 23 | + that someone else hasn't already addressed the problem. |
| 24 | +3. You create an issue before working on a contribution that will take a |
| 25 | + significant amount of your time. |
| 26 | + |
| 27 | +*Creating a Pull Request* |
| 28 | + |
| 29 | +1. Fork the repository. |
| 30 | +2. In your fork, make your change in a branch that's based on this repo's master branch. |
| 31 | +3. Commit the change to your fork, using a clear and descriptive commit message. |
| 32 | +4. Create a pull request, answering any questions in the pull request form. |
| 33 | + |
| 34 | +For contributions that will take a significant amount of time, open a new |
| 35 | +issue to pitch your idea before you get started. Explain the problem and |
| 36 | +describe the content you want to see added to the documentation. Let us know |
| 37 | +if you'll write it yourself or if you'd like us to help. We'll discuss your |
| 38 | +proposal with you and let you know whether we're likely to accept it. |
| 39 | + |
| 40 | +## Bug Reports |
12 | 41 |
|
13 | 42 | You can file bug reports against the SDK on the [GitHub issues][issues] page. |
14 | 43 |
|
@@ -40,11 +69,23 @@ guidelines prior to filing a bug report. |
40 | 69 | as well, like whether this is a persistent issue, or if it only occurs |
41 | 70 | some of the time. |
42 | 71 |
|
| 72 | +## Feature Requests |
| 73 | + |
| 74 | +Open an [issue][issues] with the following: |
| 75 | + |
| 76 | +* A short, descriptive title. Ideally, other community members should be able |
| 77 | + to get a good idea of the feature just from reading the title. |
| 78 | +* A detailed description of the the proposed feature. |
| 79 | + * Why it should be added to the SDK. |
| 80 | + * If possible, example code to illustrate how it should work. |
| 81 | +* Use Markdown to make the request easier to read; |
| 82 | +* If you intend to implement this feature, indicate that you'd like to the issue to be assigned to you. |
43 | 83 |
|
44 | | -## Submitting Pull Requests |
| 84 | +## Code Contributions |
45 | 85 |
|
46 | | -We are always happy to receive code and documentation contributions to the SDK. |
47 | | -Please be aware of the following notes prior to opening a pull request: |
| 86 | +We are always happy to receive code and documentation contributions to the SDK. |
| 87 | +Code contributions to the SDK are done through [Pull Requests][pr]. The list below are guidelines to use when submitting pull requests. These are the |
| 88 | +same set of guidelines that the core contributors use when submitting changes, and we ask the same of all community contributions as well: |
48 | 89 |
|
49 | 90 | 1. The SDK is released under the [Apache license][license]. Any code you submit |
50 | 91 | will be released under that license. For substantial contributions, we may |
@@ -113,11 +154,21 @@ so you can run command within the Docker container and context of the SDK. |
113 | 154 | make sandbox-go18 |
114 | 155 | ``` |
115 | 156 |
|
116 | | -### Changelog |
| 157 | +### Changelog Documents |
117 | 158 |
|
118 | 159 | You can see all release changes in the `CHANGELOG.md` file at the root of the |
119 | 160 | repository. The release notes added to this file will contain service client |
120 | | -updates, and major SDK changes. |
| 161 | +updates, and major SDK changes. When submitting a pull request please include an entry in `CHANGELOG_PENDING.md` under the appropriate changelog type so your changelog entry is included on the following release. |
| 162 | + |
| 163 | +#### Changelog Types |
| 164 | + |
| 165 | +* `SDK Features` - For major additive features, internal changes that have |
| 166 | +outward impact, or updates to the SDK foundations. This will result in a minor |
| 167 | +version change. |
| 168 | +* `SDK Enhancements` - For minor additive features or incremental sized changes. |
| 169 | +This will result in a patch version change. |
| 170 | +* `SDK Bugs` - For minor changes that resolve an issue. This will result in a |
| 171 | +patch version change. |
121 | 172 |
|
122 | 173 | [issues]: https://github.com/aws/aws-sdk-go/issues |
123 | 174 | [pr]: https://github.com/aws/aws-sdk-go/pulls |
|
0 commit comments