Skip to content

Commit

Permalink
chore: small fixes to DESIGN_GUIDELINES.md (#9534)
Browse files Browse the repository at this point in the history
----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
shaftoe authored Aug 13, 2020
1 parent 8992c4e commit a48e95a
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions DESIGN_GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ the AWS Construct Library in order to ensure a consistent and integrated
experience across the entire AWS surface area.

As much as possible, the guidelines in this document are enforced using the
**awslint** tool which reflects on the APIs and verifies that the APIs adhere to
the guidelines. When a guideline is backed by a linter rule, the rule name will
be referenced like this: _[awslint:resource-class-is-construct]_.
[**awslint** tool](https://www.npmjs.com/package/awslint) which reflects on the
APIs and verifies that the APIs adhere to the guidelines. When a guideline is
backed by a linter rule, the rule name will be referenced like this:
_[awslint:resource-class-is-construct]_.

For the purpose of this document we will use "Foo" to denote the official name
of the resource as defined in the AWS CloudFormation resource specification
Expand Down Expand Up @@ -147,9 +148,9 @@ behavior through interfaces and not through inheritance.
Construct classes should extend only one of the following classes
[_awslint:construct-inheritence_]:

* The **Resource** class (if it represents an AWS resource) The **Construct**
* class (if it represents an abstract component) The **XxxBase** class (which,
* in turn extends **Resource**)
* The **Resource** class (if it represents an AWS resource)
* The **Construct** class (if it represents an abstract component)
* The **XxxBase** class (which, in turn extends **Resource**)

All constructs must define a static type check method called **isFoo** with the
following implementation [_awslint:static-type-check_]:
Expand Down

0 comments on commit a48e95a

Please sign in to comment.