Skip to content

Commit 29ac48c

Browse files
authored
docs #4278
1 parent 57acdb4 commit 29ac48c

File tree

2 files changed

+16
-18
lines changed

2 files changed

+16
-18
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,14 +233,19 @@ a changelog item(s). Update the changelog via:
233233
234234
npm run newChange
235235
236+
> [!TIP]
237+
> To update an _existing_ changelog item, just edit its `.changes/next-release/….json` file, you
238+
> don't need to re-run `npm run newChange`.
239+
236240
Guidelines:
237241
242+
- If there are multiple unrelated changes, run `npm run newChange` for each change.
238243
- Describe the change in a way that is meaningful to the _customer_.
239244
- ❌ `Remove the cache when the connection wizard is re-launched`
240245
- ✅ `Connection wizard sometimes shows the old (stale) connection`
241-
- If there are multiple unrelated changes, run `npm run newChange` for each change.
242-
- **Bug Fix** changes should describe the _problem being fixed_. This tends to produce simpler,
243-
more-readable descriptions. It's redundant to mention "Fixed" in the description. Example:
246+
- "Bug Fix" changes should describe the _problem being fixed_. This tends to produce simpler,
247+
more-intuitive descriptions. It's redundant to say "Fixed" in the description, because the
248+
generated changelog will say that. Example:
244249
- ❌ `Fixed S3 bug which caused filenames to be uppercase`
245250
- ✅ `S3 filenames are always uppercase`
246251

README.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Coverage](https://img.shields.io/codecov/c/github/aws/aws-toolkit-vscode/master.svg)](https://codecov.io/gh/aws/aws-toolkit-vscode/branch/master) [![Marketplace Version](https://img.shields.io/vscode-marketplace/v/AmazonWebServices.aws-toolkit-vscode.svg) ![Marketplace Downloads](https://img.shields.io/vscode-marketplace/d/AmazonWebServices.aws-toolkit-vscode.svg)](https://marketplace.visualstudio.com/items?itemName=AmazonWebServices.aws-toolkit-vscode)
44

5-
The AWS Toolkit for Visual Studio Code is an [extension](https://marketplace.visualstudio.com/itemdetails?itemName=AmazonWebServices.aws-toolkit-vscode) for connecting your IDE to your AWS resources:
5+
AWS Toolkit is a [VS Code extension](https://marketplace.visualstudio.com/itemdetails?itemName=AmazonWebServices.aws-toolkit-vscode) for connecting your IDE to your AWS resources:
66

77
- Connect with [IAM credentials](https://docs.aws.amazon.com/sdkref/latest/guide/access-users.html),
88
[IAM Identity Center (SSO)](https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html),
@@ -15,22 +15,15 @@ The AWS Toolkit for Visual Studio Code is an [extension](https://marketplace.vis
1515
- `Search Log Group` on your CloudWatch logs
1616
- Browse your AWS resources
1717

18-
The Toolkit is available from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/itemdetails?itemName=AmazonWebServices.aws-toolkit-vscode).
19-
20-
This is an open source project because we want you to be involved. We love issues, feature requests, code reviews, pull
21-
requests or any positive contribution. See [CONTRIBUTING.md](CONTRIBUTING.md).
18+
This project is open source. We love issues, feature requests, code reviews, pull requests or any
19+
positive contribution. See [CONTRIBUTING.md](CONTRIBUTING.md) to get started.
2220

2321
## Documentation
2422

25-
- The [Quick Start Guide](README.quickstart.vscode.md) provides an overview
26-
of common Toolkit tasks.
27-
- The [User Guide](https://docs.aws.amazon.com/console/toolkit-for-vscode/welcome)
28-
contains full instructions for using the Toolkit.
29-
- See other [AWS SDKs and Tools](https://docs.aws.amazon.com/sdkref/latest/guide/overview.html).
30-
31-
## Frequently Asked Questions (FAQ) / Troubleshooting
32-
33-
[Go to page.](./docs/faq-credentials.md)
23+
- [Quick Start Guide](https://marketplace.visualstudio.com/itemdetails?itemName=AmazonWebServices.aws-toolkit-vscode)
24+
- [FAQ / Troubleshooting](./docs/faq-credentials.md)
25+
- [User Guide](https://docs.aws.amazon.com/console/toolkit-for-vscode/welcome)
26+
- General info about [AWS SDKs and Tools](https://docs.aws.amazon.com/sdkref/latest/guide/overview.html)
3427

3528
## Feedback
3629

@@ -40,7 +33,7 @@ We want your feedback!
4033
- [Ask a question](https://github.com/aws/aws-toolkit-vscode/issues/new?labels=guidance&template=guidance_request.md)
4134
- [Request a new feature](https://github.com/aws/aws-toolkit-vscode/issues/new?labels=feature-request&template=feature_request.md)
4235
- [File an issue](https://github.com/aws/aws-toolkit-vscode/issues/new?labels=bug&template=bug_report.md)
43-
- Or send a pull request!
36+
- Or [send a pull request](CONTRIBUTING.md)!
4437

4538
## License
4639

0 commit comments

Comments
 (0)