nodejs/package-maintenance

[docs] workflows (new)

Open

#341 opened on Apr 20, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees) (147 forks)github user discovery
help wanted

Repository metrics

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

Description

In #333 a Table of Contents was added for helping readers and maintainers with organizing content within the docs/ folder.

In that ToC was added a new section for documenting best practices, tips and recommendations for library maintainers, like developer / contributor guidelines, templates, automation and other ways to help assist in the maintenance of a repository, GitHub or otherwise.

Contributor guide

Research direction
Review the existing Table of Contents in the docs/ folder (added in #333) and create a new section for workflows. Identify best practices for library maintainers such as developer guidelines, templates, and automation. Propose the structure and content for the new section.
Tech stack
None
Domain
documentation
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.
1-3 hours
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.
Clear
Prerequisites
GitWriting documentation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90