Skip to content

Commit db3e265

Browse files
authored
docs(CONTRIBUTING.md) #2109
1 parent 5ff09c7 commit db3e265

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Contributing Guidelines
1+
# Contributing to AWS Toolkit for VS Code
22

3-
Thank you for your interest in contributing to our project. We greatly value
4-
feedback and contributions from our community!
3+
Thanks for taking the time to help us. We greatly value feedback and
4+
contributions from our community!
55

66
Reviewing this document will maximize your success in working with the
77
codebase and sending pull requests.
@@ -74,9 +74,12 @@ You can also use these NPM tasks (see `npm run` for the full list):
7474
7575
## Develop
7676
77-
### Code guidelines
77+
### Guidelines
7878
79-
See [CODE_GUIDELINES.md](./docs/CODE_GUIDELINES.md) for coding conventions.
79+
- Project patterns and practices: [CODE_GUIDELINES.md](./docs/CODE_GUIDELINES.md)
80+
- [VS Code Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
81+
- [VS Code API Documentation](https://code.visualstudio.com/api/references/vscode-api)
82+
- [VS Code Extension Capabilities](https://code.visualstudio.com/api/extension-capabilities/common-capabilities)
8083
8184
### Technical notes
8285

docs/CODE_GUIDELINES.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@ Toolkit for VSCode. It provides answers to common questions, decisions, UX and
55
project consistency, questions of style and code structure, and anything else
66
that cannot be enforced by a `lint` build-task.
77

8+
## UI
9+
10+
- Where possible, follow the conventions of the [VSCode User Interface](https://code.visualstudio.com/docs/getstarted/userinterface)
11+
instead of inventing new conventions.
12+
- Convention: provide global editor commands as an alternative to browsing items in the Explorer.
13+
- Instead of needing to visit service _Foo_ in the Explorer to _View_ its items, consider also providing a `AWS: Foo: View Item` command.
14+
815
## Naming
916

1017
Naming is one of the central opportunities for you as a human to add value to

0 commit comments

Comments
 (0)