nodejs/package-maintenance

Next steps on Support levels in Package.json

Open

#192 opened on Apr 8, 2019

View on GitHub
 (26 comments) (0 reactions) (1 assignee) (147 forks)github user discovery
help wantedtools

Repository metrics

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

Description

  • Make sure we follow our own guidelines in publishing of tool
  • Get input from 2 of the 'friendly' module owners
  • Update or replace tool in pkgs repo to support agreed structure
  • Minimal command in support tool to to show support info for package dependencies
  • Add support info to modules within the Node.js org.
  • Evangelise and get additional input
    • Blog outlining the support levels and how to use tool to validate
  • Final review and promote to 'docs' from drafts
  • blog on adding tool to your CI
  • PRs to modules to add in information
  • tool to scan dependencies and provide more comprehensive report on support information
  • facilitate/document how to put badges with support info elements on your package readme.
  • submit feedback top in npm/feedback repo suggesting that support information be shown on the npm page.

Contributor guide

Research direction
Examine the existing support tool in the pkgs repo to understand its current implementation, then identify an npm module without support info and create a PR to add it following the agreed structure.
Tech stack
javascriptnodejs
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
GitNode.jsnpm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50