gajus/gitinfo

When checkout in a commit, getting branch or hash throws an exception

Open

#20 opened on Aug 30, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (5 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (47 stars)
PR merge metrics
 (PR metrics pending)

Description

Hi Gajus,

Thanks for the work on this repo, it is becoming quite useful.

I have detected that when we are checked out at a commit hash, the following methods throw an exception:

gitinfo.getBranchName();
gitinfo.getHeadSha();

Contributor guide

Research direction
Examine the methods getBranchName and getHeadSha in the source code to handle the case where HEAD is detached (pointing to a commit hash).
Tech stack
javascript
Domain
tooling
Issue type
Bug
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.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70