Skip to content

docs(agents): check serverless-components before adding new code #1424

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lym953 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(agents): check serverless-components before adding new code #1424

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ The Datadog Lambda Extension ("Bottlecap") is an AWS Lambda Extension written in

All Rust code lives under `bottlecap/`. Run these from that directory unless noted.

## Where New Code Goes

The `serverless-components` repo (https://github.com/DataDog/serverless-components) holds Rust crates that this extension and the Azure and Google Cloud Platform (GCP) serverless agents share, for example `dogstatsd`, `datadog-fips` and `datadog-agent-config`.

- Before you add a new functionality, check whether `serverless-components` already has it. If it does, use it from there.
- If it does not, decide whether other serverless agents can also use the code. If they can, add it to `serverless-components`, not to this repo.
- If the decision is not clear, tell the engineer to speak with the Serverless Azure and GCP team. Do the same if you must change an existing crate in `serverless-components`.

## Code Style

- Do not be overly defensive and add unnecessary checks or tests unless you have a good reason.
Expand Down
Loading