Skip to content

Commit 5ad8e20

Browse files
authored
improv: add project tenets
Powertools now have official tenets that will guide us as we move towards GA. Tenets will also help us remain consistent across different language implementations as we grow.
1 parent 5ae7741 commit 5ad8e20

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

Diff for: README.md

+11
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@
44

55
A suite of utilities for AWS Lambda Functions that makes tracing with AWS X-Ray, structured logging and creating custom metrics asynchronously easier.
66

7+
## Tenets
8+
9+
* **AWS Lambda only** – We optimize for AWS Lambda functions environment only. Utilities might work with web frameworks, and non-Lambda environments though they are not officially supported.
10+
* **Eases the adoption of best practices** – Utilities’ main priority is to facilitate best practices adoption defined in AWS Well-Architected Serverless Lens; everything else is optional.
11+
* **Keep it lean** – Additional dependencies are carefully considered to ease maintenance, security, and to prevent negatively impacting startup time.
12+
* **We strive for backwards compatibility** – New features and changes should keep backwards compatibility. If a breaking change cannot be avoided, the deprecation and migration process should be clearly defined.
13+
* **We work backwards from the community** – We aim to strike a balance of what would
14+
work for 80% of customers. Emerging practices are considered and discussed via request for
15+
comments (RFCs)
16+
* **Idiomatic** – Utilities follow language’s idioms and their best practices.
17+
718
## Powertools available
819

920
* [Python - Beta](./python/README.md)

0 commit comments

Comments
 (0)