Skip to content

Commit 5b11c8d

Browse files
committed
remove changelog directions for now because of #3107
1 parent 79f492c commit 5b11c8d

File tree

1 file changed

+1
-37
lines changed

1 file changed

+1
-37
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,7 @@ Jump To:
2929
1. Fork the repository.
3030
2. In your fork, make your change in a branch that's based on this repo's `main` branch.
3131
3. Commit the change to your fork, using a clear and descriptive commit message.
32-
4. Create a changelog message running `make external-changelog`, replacing all
33-
values in the template
34-
5. Open a pull request, answering any questions in the pull request form.
32+
4. Open a pull request, answering any questions in the pull request form.
3533

3634
For contributions that will take a significant amount of time, open a new
3735
issue to pitch your idea before you get started. Explain the problem and
@@ -155,40 +153,6 @@ so you can run command within the Docker container and context of the SDK.
155153
make sandbox-go18
156154
```
157155

158-
### Changelog Documents
159-
160-
When submitting a pull request please include a changelog file on a folder named `.changelog`.
161-
These are used to generate the content `CHANGELOG.md` and Release Notes. The format of the file is as follows:
162-
163-
```
164-
{
165-
"id": "12345678-1234-1234-1234-123456789012"
166-
"type": "bugfix"
167-
"collapse": true
168-
"description": "Fix improper use of printf-style functions.",
169-
"modules": [
170-
".",
171-
"config",
172-
"credentials",
173-
"feature/s3/manager",
174-
"internal/endpoints/v2",
175-
"service/kinesis/internal/testing",
176-
"service/transcribestreaming/internal/testing"
177-
]
178-
}
179-
```
180-
181-
* id: a UUID. This should also be used for the name of the file, so if your id is `12345678-1234-1234-1234-123456789012` the file should be named `12345678-1234-1234-1234-123456789012.json/`
182-
* type: one of the following:
183-
* bugfix: Fixing an existing bug
184-
* Feature: Adding a new feature to an existing service
185-
* Release: Releasing a new module
186-
* Dependency: Updating dependencies
187-
* Announcement: Making an announcement, like deprecation of a module
188-
* collapse: whether this change should appear separately on the release notes on every module listed on `modules` (`"collapse": false`), or if it should show up as a single entry (`"collapse": true`)
189-
* description: Description of this change. Most of the times is the same as the title of the PR
190-
* modules: which modules does this change impact. Most of the times, these are the same as the directories that you're modifying on the PR
191-
192156
[issues]: https://github.com/aws/aws-sdk-go-v2/issues
193157
[pr]: https://github.com/aws/aws-sdk-go-v2/pulls
194158
[license]: http://aws.amazon.com/apache2.0/

0 commit comments

Comments
 (0)