JSMonk/hegel

README missing in npm tarball

Open

#245 opened on May 24, 2020

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

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

Tech stack
javascriptnodejs
Domain
releasedocumentationbuild system
Issue type
feature
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Look at the repository's packages/core and packages/cli directories to understand the build process. Check the package.json for 'build' scripts or any configuration like 'files' field or .npmignore. The maintainer may need to update the build step to copy ./README.md to the appropriate build directories before publishing.