microsoft / microsoft/beachball

Feature: show a nice summary of the bumped state after `bumpInPlace`

Open
#238 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
TypeScript
Stars
815
Forks
93
Avg merge
2d 13h
Merged PRs (30d)
12

Description

Currently we don't have a good UI for showing what is getting bumped and why and maybe how... We have a lot of that info inside the bumpInfo object now because we now bump virtually before things are written to disk. We should be able to summarize for users.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the bumpInPlace entry point and inspecting the information available in the bumpInfo object. Clarify which bump details and rationale the user-facing summary must show, then define completion around presenting that summary after the virtual bump.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.