uber/manifold

CI / dev experience remaining issues

Open

#28 opened on Sep 12, 2019

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (119 forks)batch import
dev exphelp wanted

Repository metrics

Stars
 (1,619 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

  • add readme to npm homepage https://www.npmjs.com/package/@mlvis/manifold
  • add publishing script to Travis CI
  • auto bump version in the main package.json (currently ocular-publish only bumps versions in modules package.json
  • install storybook for development purpose
  • properly structure published module (below is the current structure, which causes import Manifold from '@mlvis/manifold' to not work #27 image
  • add depcheck
  • use gh-pages module to deploy website

Contributor guide

Research direction
Focus on adding a README to the npm package page. Check if package.json has a 'readme' field or if npm automatically displays the root README.md. Ensure the README exists and is properly formatted with installation and usage instructions. Then verify the package appears correctly at https://www.npmjs.com/package/@mlvis/manifold.
Tech stack
javascriptnodejs
Domain
devopstoolingdocumentation
Issue type
Chore
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.
1-3 hours
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.
Mostly clear
Prerequisites
Gitnpm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60