angular-fullstack/generator-angular-fullstack

Doc Enhancement Suggestion - Gruntfile Explanation

Open

#1,850 opened on May 4, 2016

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (1,268 forks)batch import
Help Wantedinfo

Repository metrics

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

Description

Completely just a documentation enhancement idea but due to the popularity of this repo, it would be nice to see from someone with a little more expertise than me, a readme documenting the build process produced by the Gruntfile. How each process produces an independent result through the pipeline, etc.

Contributor guide

Research direction
Examine the Gruntfile in the repository, understand each task (e.g., clean, build, serve, test) and their interdependencies in the pipeline, then write a clear README section explaining the build process.
Tech stack
javascriptnodejsangularexpress
Domain
build system
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
GruntJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95