From: Iskren Chernev <iskren.chernev@gmail.com>
Date: Fri, 17 Apr 2015 05:30:00 +0000 (-0700)
Subject: Update CONTRIBUTING with info about ES6 modules
X-Git-Tag: 2.10.3~29
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ac5d7bdb011e1da394bce3cd40fbfe34ae2dcdcc;p=thirdparty%2Fmoment.git

Update CONTRIBUTING with info about ES6 modules
---

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8d0f2bee4..edacb3ba2 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -3,10 +3,42 @@ Submitting Issues
 
 If you are submitting a bug, please create a [jsfiddle](http://jsfiddle.net/) demonstrating the issue.
 
-Contributing code
+Read before submitting Pull Requests
+====================================
+
+ * **Pull requests to the `master` branch will be closed.** Please submit all pull requests to the `develop` branch.
+ * **Locale translations will not be merged without unit tests.** See [the British English unit tests](https://github.com/moment/moment/blob/develop/src/test/locale/en-gb.js) for an example.
+ * **Do not include the minified files in your pull request.** These are
+   `moment.js`, `locale/*.js`, `min/*.js`. Don't worry, we'll build them when
+   we cut a release.
+
+Code organization
 =================
 
-To contribute, fork the library and install grunt and dependencies. You need [node](http://nodejs.org/); use [nvm](https://github.com/creationix/nvm) or [nenv](https://github.com/ryuone/nenv) to install it.
+Starting from version 2.10.0 the code is placed under `src/`.
+`moment.js`, `locale/*.js`, `min/*.js` are generated only on release.
+
+**DO NOT** submit changes to the generated files. Instead only change
+`src/**/*.js` and run the tests.
+
+* `src/lib/**/*.js` moment core files
+* `src/locale/*.js` locale files
+* `src/test/moment/*.js` moment core tests
+* `src/test/locale/*.js` locale tests
+
+We're using ES6 module system, but nothing else ES6, because of performance
+considerations (added code by the transpiler, less than optimal translation to
+ES5). So please do not use that fancy new ES6 feature in your patch, it won't
+be accepted.
+
+Setting up development environment
+==================================
+
+To contribute, fork the library and install grunt and dependencies. You need
+[git](http://git-scm.com/) and
+[node](http://nodejs.org/); you might use
+[nvm](https://github.com/creationix/nvm) or
+[nenv](https://github.com/ryuone/nenv) to install node.
 
 ```bash
 git clone https://github.com/moment/moment.git
@@ -29,13 +61,6 @@ In order for your pull request to get merged it must have approval of original
 author, or at least one other native speaker has to approve of the change
 (happens rarely).
 
-Very important notes
-====================
-
- * **Pull requests to the `master` branch will be closed.** Please submit all pull requests to the `develop` branch.
- * **Locale translations will not be merged without unit tests.** See [the British English unit tests](https://github.com/moment/moment/blob/develop/src/test/locale/en-gb.js) for an example.
- * **Do not include the minified files in your pull request.** Don't worry, we'll build them when we cut a release.
-
 Grunt tasks
 ===========
 
@@ -43,6 +68,7 @@ We use Grunt for managing the build. Here are some useful Grunt tasks:
 
   * `grunt` The default task lints the code and runs the tests. You should make sure you do this before submitting a PR.
   * `grunt test` run the tests.
-  * `grunt release` Build everything, including minified files
+  * `grunt release` Build everything, including minified files (do not include
+    those in Pull Requests)
   * `grunt transpile:fr,ru` Build custom locale bundles `moment-with-locales.custom.js` and `locales.custom.js` inside `build/umd/min` containing just French and Russian.
   * `grunt size` Print size statistics.