benchmark-action / benchmark-action/github-action-benchmark

Feature request: benchmark description

Open
#278 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
1.3k
Forks
184
PR merge metrics
No merged PRs in 30d

Description

## Request

Add a new optional property `description` to each benchmark. When present, the description is displayed below the benchmark name or below the benchmark graph.

## Rationale

If we look for example at https://zio.github.io/zio-kafka/dev/bench/ we see vague benchmark names that are derived from code names. By themselves they make sense, but _every time_ we need to look up what the benchmark actually does.

_Without the description, the benchmark result cannot be interpreted and is therefore worthless._

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.