alexcasalboni/aws-lambda-power-tuning

Add optional description field for output report

Open

#188 opened on Feb 15, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (4,670 stars) (325 forks)batch import
enhancementhelp wanted

Description

This could be as simple as an optional "description" or "notes" field in the state machine intput, that will be passed as is to the state machine output, mainly to explain the context/configuration of the power-tuning execution.

Contributor guide

Tech stack
javascriptaws
Domain
cloudperformancetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic JavaScriptAWS Step Functions concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Investigate the state machine definition file (likely `state machine.json` or similar) to identify the current input and output schemas. Look at the Lambda function handler that processes the input to understand how fields are passed through. Check the comments on the issue for any additional requirements or questions from maintainers. Implement an optional `description` field that is added to the output object without modification.