johnpapa/vscode-pwa

Add Details to Configurable Items in the Templates Generated

Open

#3 opened on Jun 12, 2017

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

Repository metrics

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

Description

After providing the code in the generate-sw.js file the extension allows you to tab through and modify some of the contents that were generated (e.g. BUILD_DIR, SW). It would be nice to have some documentation describing what the extension tools suggests you modify, what they're used for/why we might modify what was generated.

This applies across the tools and not just the pwa-generate-service-worker piece.

Contributor guide

Research direction
Look at the template files in the extension and add descriptive comments or a separate documentation file about each configurable item, explaining its purpose and usage.
Tech stack
typescript
Domain
documentationdeveloper experience
Issue type
Documentation
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.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80