bitovi/funcunit

Improve the FuncUnit.com build

Open

#196 opened on Apr 6, 2017

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (575 stars) (395 forks)batch import
cleanupdeveloper relationshelp wantedp2website

Description

You can run make to build & deploy the FuncUnit site, but the way it works seems like a hack:

  • The site folder has its own Makefile and package.json, which seems odd
  • At least one file is force-added unnecessarily (that whole script could probably use some attention/verification)
  • Static resources are loaded from different folders, depending on which main section you’re on (i.e. the home page loads resources from site/static, while the Guides page loads from guides/static)

Home page:

Guides page:

Contributor guide

Tech stack
shelljavascript
Domain
build system
Issue type
refactor
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with MakefilesBasic JavaScript/Node.js knowledgeUnderstanding of static site builds
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Review the Makefiles in the root and site/ directories, and the site/package.json. Investigate why the site folder has its own build setup and if it can be consolidated. Look into the force added file in the root Makefile (line 15) to verify if it's necessary. Also explore the static resource loading differences between home page and guides page to see if they can be unified.