rtfeldman/seamless-immutable

Please clarify the docs regarding when dev/prod modes are on (Node)

Open

#50 opened on Jul 14, 2015

View on GitHub
 (10 comments) (0 reactions) (0 assignees)JavaScript (221 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (5,367 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Hello,

perhaps it wasn't my brightest day :-) but I found it difficult to find out when the dev or prod modes are active under Node.js. It would be great clarify that in the docs.

I believe this is true (and exhaustive) but am not sure:

/*1.*/ var Immutable = require('seamless-immutable'); // => dev mode
/*2.*/ var Immutable = require('seamless-immutable/seamless-immutable.production.min'); // => prod mode
/*3.*/ var Immutable = require('seamless-immutable/seamless-immutable.production.min'); process.env.NODE_ENV = "development"; // => dev mode

Thank you!

Contributor guide

Research direction
Review the library's documentation and source code to confirm how dev and prod modes are determined, then update the docs accordingly.
Tech stack
javascriptnodejs
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.
Under 1 hour
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85