Skip to content

UG should document special ramp color for delete-only contributions #2621

Description

@CYX22222003

Problem

The User Guide explains the general ramp chart color behavior, but it does not mention the special color used for delete-only contributions.

From the current frontend implementation in frontend/src/components/c-ramp.vue, a ramp is treated as a delete-only contribution when:

insertions === 0 && deletions > 0

In that case, getRampColor / getSliceColor returns '-deletes', and the ramp is rendered using ramp__slice--color-deletes, which is red.

This can confuse users who are trying to understand what ramp colors represent, because red is not part of the normal rotating ramp color scheme.

Expected Documentation

The User Guide should clarify that:

  • Normal ramps use the regular rotating time-period colors.
  • Delete-only ramps use a separate red color.
  • Mixed contributions, such as +10 -5, still use the normal ramp color, not the delete-only color.

Suggested Location

This can be documented in the Ramp charts section of the User Guide, near the existing explanation of ramp color behavior.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions