WhitestormJS/whs.js

Markdown guide for examples

Open

#253 opened on Jun 17, 2017

View on GitHub
 (5 comments) (0 reactions) (1 assignee)JavaScript (425 forks)batch import
EXAMPLESHacktoberfestMAINTAINANCEREFACTORING

Repository metrics

Stars
 (6,070 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I'd like to see this feature in docs/examples. Some "complex" or popular examples should have alike description tab that explains:

  • How to build such app step-by-step
  • Which modules were used (that are not in whs build)
  • Some tips that you should note while making a similar thing
Version:
  • v2.x.x
  • v1.x.x
Issue type:
  • Bug
  • Proposal/Enhancement
  • Question
  • Discussion
Desktop
  • Chrome
  • Chrome Canary
  • Chrome dev-channel
  • Firefox
  • Opera
  • Microsoft IE
  • Microsoft Edge
Android
  • Chrome
  • Firefox
  • Opera
IOS
  • Chrome
  • Firefox
  • Opera

Contributor guide

Research direction
Tech stack
Domain
Issue type
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Prerequisites
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.