This repository has been archived by the owner on Oct 7, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 97
docs: Add deprecation policy #12
Open
geek
wants to merge
4
commits into
nodejs:master
Choose a base branch
from
geek:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # Deprecation Policy | ||
|
|
||
| Any undocumented API or function is subject to change at any time. Only documented APIs are subject to the following | ||
| policy. | ||
|
|
||
|
|
||
| ## Stage 1 | ||
|
|
||
| 1. The technical committee decides to deprecate an officially supported API. | ||
| 2. The function is changed to the `util.deprecate` function with a message that indicates the intent for removal and a | ||
| suggested replacement API to use, if there is one. | ||
| 3. The API documentation is updated to reflect that the API functionality will be removed in the future. | ||
| 4. The changed API is released with the minor version being incremented. | ||
| 5. An issue is filed to delete the deprecated API | ||
|
|
||
|
|
||
| ## Stage 2 | ||
|
|
||
| 1. During the third month since the release of the deprecated API, the API should be deleted. The | ||
| related issue from step 5 stage 1 is closed. | ||
| 2. The API documentation is updated to reflect that the API functionality has been deleted. | ||
| 3. Release notes are created to guide developers on the breaking change and how to upgrade. | ||
| 4. The major version is incremented and a release is issued | ||
| 5. An issue is filed to remove the note from the API documentation | ||
|
|
||
|
|
||
| ## Stage 3 | ||
|
|
||
| 1. Remove the note from the API documentation and close the issue from step 5 stage 2. | ||
| 2. The documentation change can go out with any future release | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,303 +1,18 @@ | ||
| io.js | ||
| Node.js Foundation - Node.js | ||
| ===== | ||
|
|
||
| [](https://gitter.im/iojs/io.js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | ||
| This repository is the working repository for the proposed convergence of the | ||
| http://github.com/iojs/io.js and http://github.com/joyent/node projects under | ||
| the Node.js Foundation. | ||
|
|
||
| This repository began as a GitHub fork of | ||
| [joyent/node](https://github.com/joyent/node). | ||
| Contributions, releases, and contributorship are under the proposed | ||
| Governance and Developer Policy for the soon-to-be-launched Node.js | ||
| Foundation: | ||
|
|
||
| io.js contributions, releases, and contributorship are under an | ||
| [open governance model](./GOVERNANCE.md). | ||
| We intend to land, with increasing regularity, releases which are | ||
| compatible with the npm ecosystem that has been built to date for | ||
| Node.js. | ||
| * https://github.com/joyent/nodejs-advisory-board/tree/master/governance-proposal | ||
| * http://github.com/jasnell/dev-policy | ||
|
|
||
| ## Is it io.js or IO.js or iojs or IOjs or iOjS? | ||
| This project is operating with the oversight of the joint Node.js and io.js | ||
| core technical teams. | ||
|
|
||
| The official name is **io.js**, which should never be capitalized, | ||
| especially not at the start of a sentence, unless it is being | ||
| displayed in a location that is customarily all-caps (such as | ||
| the title of man pages). | ||
|
|
||
| ## Download | ||
|
|
||
| Binaries, installers, and source tarballs are available at | ||
| <https://iojs.org>. | ||
|
|
||
| **Releases** are available at <https://iojs.org/dist/>, listed under | ||
| their version string. The <https://iojs.org/dist/latest/> symlink | ||
| will point to the latest release directory. | ||
|
|
||
| **Nightly** builds are available at | ||
| <https://iojs.org/download/nightly/>, listed under their version | ||
| string which includes their date (in UTC time) and the commit SHA at | ||
| the HEAD of the release. | ||
|
|
||
| **API documentation** is available in each release and nightly | ||
| directory under _docs_. <https://iojs.org/api/> points to the latest version. | ||
|
|
||
| ### Verifying Binaries | ||
|
|
||
| Release and nightly download directories all contain a *SHASUM256.txt* | ||
| file that lists the SHA checksums for each file available for | ||
| download. To check that a downloaded file matches the checksum, run | ||
| it through `sha256sum` with a command such as: | ||
|
|
||
| ``` | ||
| $ grep iojs-vx.y.z.tar.gz SHASUMS256.txt | sha256sum -c - | ||
| ``` | ||
|
|
||
| _(Where "iojs-vx.y.z.tar.gz" is the name of the file you have | ||
| downloaded)_ | ||
|
|
||
| Additionally, releases (not nightlies) have GPG signed copies of | ||
| SHASUM256.txt files available as SHASUM256.txt.asc. You can use `gpg` | ||
| to verify that the file has not been tampered with. | ||
|
|
||
| To verify a SHASUM256.txt.asc, you will first need to import all of | ||
| the GPG keys of individuals authorized to create releases. They are | ||
| listed at the bottom of this README. Use a command such as this to | ||
| import the keys: | ||
|
|
||
| ``` | ||
| $ gpg --keyserver pool.sks-keyservers.net \ | ||
| --recv-keys DD8F2338BAE7501E3DD5AC78C273792F7D83545D | ||
| ``` | ||
|
|
||
| _(Include each of the key fingerprints at the end of this command.)_ | ||
|
|
||
| You can then use `gpg --verify SHASUMS256.txt.asc` to verify that the | ||
| file has been signed by an authorized member of the io.js team. | ||
|
|
||
| Once verified, use the SHASUMS256.txt.asc file to get the checksum for | ||
| the binary verification command above. | ||
|
|
||
| ## Build | ||
|
|
||
| ### Unix / Macintosh | ||
|
|
||
| Prerequisites: | ||
|
|
||
| * `gcc` and `g++` 4.8 or newer, or | ||
| * `clang` and `clang++` 3.4 or newer | ||
| * Python 2.6 or 2.7 | ||
| * GNU Make 3.81 or newer | ||
| * libexecinfo (FreeBSD and OpenBSD only) | ||
|
|
||
| ```text | ||
| $ ./configure | ||
| $ make | ||
| $ [sudo] make install | ||
| ``` | ||
|
|
||
| If your Python binary is in a non-standard location or has a | ||
| non-standard name, run the following instead: | ||
|
|
||
| ```text | ||
| $ export PYTHON=/path/to/python | ||
| $ $PYTHON ./configure | ||
| $ make | ||
| $ [sudo] make install | ||
| ``` | ||
|
|
||
| To run the tests: | ||
|
|
||
| ```text | ||
| $ make test | ||
| ``` | ||
|
|
||
| To build the documentation: | ||
|
|
||
| ```text | ||
| $ make doc | ||
| ``` | ||
|
|
||
| To read the documentation: | ||
|
|
||
| ```text | ||
| $ man doc/iojs.1 | ||
| ``` | ||
|
|
||
| ### Windows | ||
|
|
||
| Prerequisites: | ||
|
|
||
| * [Python 2.6 or 2.7](https://www.python.org/downloads/) | ||
| * Visual Studio 2013 for Windows Desktop, or | ||
| * Visual Studio Express 2013 for Windows Desktop | ||
| * Basic Unix tools required for some tests, | ||
| [Git for Windows](http://git-scm.com/download/win) includes Git Bash | ||
| and tools which can be included in the global `PATH`. | ||
|
|
||
| ```text | ||
| > vcbuild nosign | ||
| ``` | ||
|
|
||
| To run the tests: | ||
|
|
||
| ```text | ||
| > vcbuild test | ||
| ``` | ||
|
|
||
| ### Android / Android based devices, aka. Firefox OS | ||
|
|
||
| Be sure you have downloaded and extracted [Android NDK] | ||
| (https://developer.android.com/tools/sdk/ndk/index.html) | ||
| before in a folder. Then run: | ||
|
|
||
| ``` | ||
| $ ./android-configure /path/to/your/android-ndk | ||
| $ make | ||
| ``` | ||
|
|
||
| ### `Intl` (ECMA-402) support: | ||
|
|
||
| [Intl](https://github.com/joyent/node/wiki/Intl) support is not | ||
| enabled by default. | ||
|
|
||
| #### "small" (English only) support | ||
|
|
||
| This option will build with "small" (English only) support, but | ||
| the full `Intl` (ECMA-402) APIs. With `--download=all` it will | ||
| download the ICU library as needed. | ||
|
|
||
| Unix / Macintosh: | ||
|
|
||
| ```text | ||
| $ ./configure --with-intl=small-icu --download=all | ||
| ``` | ||
|
|
||
| Windows: | ||
|
|
||
| ```text | ||
| > vcbuild small-icu download-all | ||
| ``` | ||
|
|
||
| The `small-icu` mode builds with English-only data. You can add full | ||
| data at runtime. | ||
|
|
||
| *Note:* more docs are on | ||
| [the joyent/node wiki](https://github.com/joyent/node/wiki/Intl). | ||
|
|
||
| #### Build with full ICU support (all locales supported by ICU): | ||
|
|
||
| With the `--download=all`, this may download ICU if you don't have an | ||
| ICU in `deps/icu`. | ||
|
|
||
| Unix / Macintosh: | ||
|
|
||
| ```text | ||
| $ ./configure --with-intl=full-icu --download=all | ||
| ``` | ||
|
|
||
| Windows: | ||
|
|
||
| ```text | ||
| > vcbuild full-icu download-all | ||
| ``` | ||
|
|
||
| #### Build with no Intl support `:-(` | ||
|
|
||
| The `Intl` object will not be available. This is the default at | ||
| present, so this option is not normally needed. | ||
|
|
||
| Unix / Macintosh: | ||
|
|
||
| ```text | ||
| $ ./configure --with-intl=none | ||
| ``` | ||
|
|
||
| Windows: | ||
|
|
||
| ```text | ||
| > vcbuild intl-none | ||
| ``` | ||
|
|
||
| #### Use existing installed ICU (Unix / Macintosh only): | ||
|
|
||
| ```text | ||
| $ pkg-config --modversion icu-i18n && ./configure --with-intl=system-icu | ||
| ``` | ||
|
|
||
| #### Build with a specific ICU: | ||
|
|
||
| You can find other ICU releases at | ||
| [the ICU homepage](http://icu-project.org/download). | ||
| Download the file named something like `icu4c-**##.#**-src.tgz` (or | ||
| `.zip`). | ||
|
|
||
| Unix / Macintosh | ||
|
|
||
| ```text | ||
| # from an already-unpacked ICU: | ||
| $ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu | ||
|
|
||
| # from a local ICU tarball | ||
| $ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu.tgz | ||
|
|
||
| # from a tarball URL | ||
| $ ./configure --with-intl=full-icu --with-icu-source=http://url/to/icu.tgz | ||
| ``` | ||
|
|
||
| Windows | ||
|
|
||
| First unpack latest ICU to `deps/icu` | ||
| [icu4c-**##.#**-src.tgz](http://icu-project.org/download) (or `.zip`) | ||
| as `deps/icu` (You'll have: `deps/icu/source/...`) | ||
|
|
||
| ```text | ||
| > vcbuild full-icu | ||
| ``` | ||
|
|
||
| ## Resources for Newcomers | ||
|
|
||
| * [CONTRIBUTING.md](./CONTRIBUTING.md) | ||
| * [GOVERNANCE.md](./GOVERNANCE.md) | ||
| * IRC: | ||
| [#io.js on Freenode.net](http://webchat.freenode.net?channels=io.js&uio=d4) | ||
| * [iojs/io.js on Gitter](https://gitter.im/iojs/io.js) | ||
|
|
||
|
|
||
|
|
||
| ## Current Project Team Members | ||
|
|
||
| The io.js project team comprises a group of core collaborators and a sub-group | ||
| that forms the _Technical Committee_ (TC) which governs the project. For more | ||
| information about the governance of the io.js project, see | ||
| [GOVERNANCE.md](./GOVERNANCE.md). | ||
|
|
||
| * **Isaac Z. Schlueter** ([@isaacs](https://github.com/isaacs)) <i@izs.me> (Technical Committee) | ||
| * **Ben Noordhuis** ([@bnoordhuis](https://github.com/bnoordhuis)) <info@bnoordhuis.nl> (Technical Committee) | ||
| * **Bert Belder** ([@piscisaureus](https://github.com/piscisaureus)) <bertbelder@gmail.com> (Technical Committee) | ||
| * **Fedor Indutny** ([@indutny](https://github.com/indutny)) <fedor.indutny@gmail.com> (Technical Committee) | ||
| * **Trevor Norris** ([@trevnorris](https://github.com/trevnorris)) <trev.norris@gmail.com> (Technical Committee) | ||
| * **Chris Dickinson** ([@chrisdickinson](https://github.com/chrisdickinson)) <christopher.s.dickinson@gmail.com> (Technical Committee) | ||
| - Release GPG key: 9554F04D7259F04124DE6B476D5A82AC7E37093B | ||
| * **Colin Ihrig** ([@cjihrig](https://github.com/cjihrig)) <cjihrig@gmail.com> | ||
| * **Mikeal Rogers** ([@mikeal](https://github.com/mikeal)) <mikeal.rogers@gmail.com> | ||
| * **Rod Vagg** ([@rvagg](https://github.com/rvagg)) <rod@vagg.org> (Technical Committee) | ||
| - Release GPG key: DD8F2338BAE7501E3DD5AC78C273792F7D83545D | ||
| * **Thorsten Lorenz** ([@thlorenz](https://github.com/thlorenz)) <thlorenz@gmx.de> | ||
| * **Stephen Belanger** ([@qard](https://github.com/qard)) <admin@stephenbelanger.com> | ||
| * **Jeremiah Senkpiel** ([@fishrock123](https://github.com/fishrock123)) <fishrock123@rocketmail.com> (Technical Committee) | ||
| - Release GPG key: FD3A5288F042B6850C66B31F09FE44734EB7990E | ||
| * **Evan Lucas** ([@evanlucas](https://github.com/evanlucas)) <evanlucas@me.com> | ||
| * **Brendan Ashworth** ([@brendanashworth](https://github.com/brendanashworth)) <brendan.ashworth@me.com> | ||
| * **Vladimir Kurchatkin** ([@vkurchatkin](https://github.com/vkurchatkin)) <vladimir.kurchatkin@gmail.com> | ||
| * **Nikolai Vavilov** ([@seishun](https://github.com/seishun)) <vvnicholas@gmail.com> | ||
| * **Nicu Micleușanu** ([@micnic](https://github.com/micnic)) <micnic90@gmail.com> | ||
| * **Aleksey Smolenchuk** ([@lxe](https://github.com/lxe)) <lxe@lxe.co> | ||
| * **Shigeki Ohtsu** ([@shigeki](https://github.com/shigeki)) <ohtsu@iij.ad.jp> | ||
| * **Sam Roberts** ([@sam-github](https://github.com/sam-github)) <vieuxtech@gmail.com> | ||
| * **Wyatt Preul** ([@geek](https://github.com/geek)) <wpreul@gmail.com> | ||
| * **Brian White** ([@mscdex](https://github.com/mscdex)) <mscdex@mscdex.net> | ||
| * **Christian Vaagland Tellnes** ([@tellnes](https://github.com/tellnes)) <christian@tellnes.com> | ||
| * **Robert Kowalski** ([@robertkowalski](https://github.com/robertkowalski)) <rok@kowalski.gd> | ||
| * **Julian Duque** ([@julianduque](https://github.com/julianduque)) <julianduquej@gmail.com> | ||
| * **Johan Bergström** ([@jbergstroem](https://github.com/jbergstroem)) <bugs@bergstroem.nu> | ||
| * **Roman Reiss** ([@silverwind](https://github.com/silverwind)) <me@silverwind.io> | ||
| * **Petka Antonov** ([@petkaantonov](https://github.com/petkaantonov)) <petka_antonov@hotmail.com> | ||
| * **Yosuke Furukawa** ([@yosuke-furukawa](https://github.com/yosuke-furukawa)) <yosuke.furukawa@gmail.com> | ||
|
|
||
| Collaborators follow the [COLLABORATOR_GUIDE.md](./COLLABORATOR_GUIDE.md) in | ||
| maintaining the io.js project. | ||
| Note: The original io.js README.md is temporarily renamed to iojs_README.md. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This goes against what we've defined previously in the dev-policy, with regards to "implicit" and "explicit" public APIs, IIRC.