Skip to content
This repository has been archived by the owner on Jul 31, 2018. It is now read-only.

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
trevnorris committed Dec 18, 2015
0 parents commit d8eb50e
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 0 deletions.
1 change: 1 addition & 0 deletions 000-index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Node.js Enhancement Proposals
61 changes: 61 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Node.js Enhancement Proposals

## Overview

This repository contains the Node Enhancement Proposals (EPs) collection. These
are documents describing an enhancement proposal for inclusion in Node.

EPs are used when the proposed feature is a substantial new API, is too broad
or would modify APIs heavily. Minor changes do not require writing an EP. What
is and isn't minor is subjective, so as a general rule, users should discuss
the proposal briefly by other means (issue tracker, mailing list or IRC) and
write a EP when requested by the Node core team.

## Rational

The idea behind the EP process is to keep track of what ideas will be worked on
and which ones where discarded, and why. This should help everyone (those
closely involved with the project and newcomers) have a clear picture of where
Node stands and where it want to be in the future.

## Format

EP documents don't follow a given format (other than being written in
MarkDown). It is, however, required that all EPs include the following
information at the top of the file:

* Title
* Name of author
* Status (more on statuses later, new documents must be submitted with the
'draft' status
* Date

The document file name must conform to the following format:
`"XXX-title-ish.md"` and it must be added to the document index in
`000-index.md`.

## Content

EP documents should be as detailed as possible. Any type of media which helps
clarify what it tries to describe is more than welcome, be that an ASCII
diagram, pseudocode or actual C code.

## Licensing

All EP documents must be MIT licensed.

## Progress of a EP

All EPs will be committed to the repository regardless of their acceptance.
The initial status shall be **"DRAFT"**.

If the document is uncontroversial and agreement is reached quickly it might be
committed directly with the **"ACCEPTED"** status. Likewise, if the proposal is
rejected the status shall be **"REJECTED"**. When a document is rejected a
member of the core team should append a section describing the reasons for
rejection.

A document shall also be committed in **"DRAFT"** status. This means consensus
has not been reached yet.

The author of a EP is expected to actually pursue and implement the proposal.

0 comments on commit d8eb50e

Please sign in to comment.