JSMonk/hegel

README missing in npm tarball

Open

#245 opened on May 24, 2020

View on GitHub
 (4 comments) (1 reaction) (0 assignees)JavaScript (55 forks)batch import
enhancementgood first issue

Repository metrics

Stars
 (2,047 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I don't know how your publishing up to npm but I strongly recommend you update your build step to also copy the ./README.md into ./packages/core/build/README.md so that it's published with the npm tarball.

Contributor guide

Research direction
Examine the build script in package.json to see how the package is built and published, then ensure README.md is copied into the build output directories for @hegel/cli and @hegel/core.
Tech stack
javascriptnodejs
Domain
documentationbuild system
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
npm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90