Merge pull request #2 from mrdoob/dev

update

Author: 11zouzouzou

.github/CONTRIBUTING.md

@@ -1,27 +1,7 @@
-
-# Help
-The issues section is for bug reports and feature requests only. If you need help, please use the [forum](http://discourse.threejs.org/) or [stackoverflow](http://stackoverflow.com/questions/tagged/three.js).
-
-# Bugs
-#### Before reporting a bug
-
-1. Search issue tracker for similar issues.
-2. Try the latest dev branch version of three.js.
-3. Refer to the [Migration Guide](https://github.com/mrdoob/three.js/wiki/Migration) when upgrading to the dev version.
-
-#### How to report a bug
-
-1. Specify the revision number of the three.js library where the bug occurred.
-2. Specify your browser version, operating system, and graphics card. (for example, Chrome 23.0.1271.95, Windows 7, Nvidia Quadro 2000M)
-3. Describe the problem in detail. Explain what happened, and what you expected would happen.
-4. Provide a small test-case (http://jsfiddle.net). [Here is a fiddle](https://jsfiddle.net/3foLr7sn/) you can edit that runs the current version. [And here is a fiddle](https://jsfiddle.net/qgu17w5o/) that uses the dev branch. If a test-case is not possible, provide a link to a live version of your application.
-5. If helpful, include a screenshot. Annotate the screenshot for clarity.
-
 # Contribution
-#### Introduction
+## Introduction
 
-It is assumed that you know a little about node.js and git. If not, [here's some help to get started
-with git](https://help.github.com/en/github/using-git) and [here’s some help to get started with node.js.](https://nodejs.org/en/docs/guides/getting-started-guide/)
+It is assumed that you know a little about node.js and git. If not, [here's some help to get started with git](https://help.github.com/en/github/using-git) and [here’s some help to get started with node.js.](https://nodejs.org/en/docs/guides/getting-started-guide/)
 
 * Install [Node.js](https://nodejs.org/)
 * Install [Git](https://git-scm.com/)
@@ -30,65 +10,73 @@ with git](https://help.github.com/en/github/using-git) and [here’s some help t
 * Change into the directory you’d like
 * Clone your forked repo
 
-        git clone https://github.com/[yourgithubname]/three.js.git
+      git clone https://github.com/[yourgithubname]/three.js.git
+
 * Go into the three.js directory.
 
-        cd ./three.js
+      cd ./three.js
+
 * Install the dependencies
 
-        npm install
+      npm install
 
-#### Next Steps
+## Next Steps
 
 As per the npm standard, ‘start’ is the place to begin the package.
 
     npm start
 
-This script will start a local server similar to three.js, but instead will be hosted on your local
-machine. Browse to http://localhost:8080/ to check it out. It also automatically creates the
-‘build/three.js’ and ‘build/three.module.js’ scripts anytime there is a change within your three.js
-directory.
+This script will start a local server similar to [threejs.org](https://threejs.org/), but instead will be hosted on your local machine. Browse to http://localhost:8080/ to check it out. It also automatically creates the ‘build/three.js’ and ‘build/three.module.js’ scripts anytime there is a change within your three.js directory.
 
-The next most important script runs all the appropriate testing.
-        
-        npm test
+The next most important script runs all the appropriate testing. The E-2-E testing is intended to be run by github actions.
 
-The linting is there to keep a consistent code-style across the all of the code and the testing is
-there to help catch bugs and check that the code behaves as expected. It is important that
-neither of these steps comes up with any errors due to your changes.
+    npm test
+
+The linting is there to keep a consistent code-style across the all of the code and the testing is there to help catch bugs and check that the code behaves as expected. It is important that neither of these steps comes up with any errors due to your changes.
+
+Many linting errors can be fixed automatically by running
+
+    npm lint-fix
 
 If you’d like to make a minified version of the build files i.e. ‘build/three.min.js’ run:
 
-    npm run-script build-closure
+    npm run build
 
-#### Making changes
+## Making changes
 
 When you’ve decided to make changes, start with the following:
+
 * Update your local repo
 
-        git pull https://github.com/mrdoob/three.js.git
-        git push
+      git pull https://github.com/mrdoob/three.js.git
+      git push
+
 * Make a new branch from the dev branch
 
-        git checkout dev
-        git branch [mychangesbranch]
-        git checkout [mychangesbranch]
+      git checkout dev
+      git branch [mychangesbranch]
+      git checkout [mychangesbranch]
+
 * Add your changes to your commit.
 * Push the changes to your forked repo.
 * Open a Pull Request (PR)
 
-Important notes:
+## Important notes:
+
 * Don't include any build files to your commit.
 * Not all new features will need a new example. Simpler features could be incorporated into an existing example. Bigger features may be asked to add an example demonstrating the feature.
 * Making changes may require changes to the documentation. If so, please make a new PR for the appropriate doc changes. To update the Chinese docs, simply copy the English to begin with.
 * it's good to also add an example and screenshot for it, for showing how it's used and for end-to-end testing.
 * If you modify existing code, run relevant examples to check they didn't break and there wasn't performance regress.
 * If you add some assets for the examples (models, textures, sounds, etc), make sure they have a proper license allowing for their use here, less restrictive the better. It is unlikely for large assets to be accepted.
 * If some issue is relevant to patch / feature, please mention it with hash (e.g. #2774) in a commit message to get cross-reference in GitHub.
-* If you modify files in examples/js directory, then don't perform any changes in the examples/jsm, JavaScript modules are auto-generated via running ‘node utils/modularize.js’.
-* If end-to-end test failed in Travis and you are sure that all is correct, make a new screenshots with npm run make-screenshot <example_1_name> ... <example_N_name> .
-* Watch out for Closure compiler warnings when building the libs, there should not be any.
+* If you modify files in `examples/js` directory, then don't perform any changes in the `examples/jsm`, JavaScript modules are auto-generated via running `node utils/modularize.js`.
+* If end-to-end test failed in Travis and you are sure that all is correct, make a new screenshots with 
+
+      npm run make-screenshot <example_1_name> ...<example_N_name>
+
 * Once done with a patch / feature do not add more commits to a feature branch
 * Create separate branches per patch or feature.
+* If you make a PR but it is not actually ready to be pulled into the dev branch, add `[Draft]` into the PR title and/or convert it to a draft PR
 
-This project is currently contributed to mostly via everyone's spare time. Please keep that in mind as it may take some time for the appropriate feedback to get to you. If you are unsure about adding a new feature, it might be better to ask first to see whether other people think it's a good idea.
+This project is currently contributed to mostly via everyone's spare time. Please keep that in mind as it may take some time for the appropriate feedback to get to you. If you are unsure about adding a new feature, it might be better to ask first to see whether other people think it's a good idea.

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: [mrdoob, HumanInteractive]

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,47 @@
+---
+name: Bug report
+about: Report a reproducible bug or regression.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+<!-- Ignoring this template may result in your bug report getting deleted -->
+
+**Describe the bug**
+
+A clear and concise description of what the bug is. Before submitting, please remove unnecessary sections.
+
+**To Reproduce**
+
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. See error
+
+***Code***
+
+```js
+// code goes here
+```
+
+***Live example***
+
+* [jsfiddle-latest-release](https://jsfiddle.net/hyok6tvj/)
+* [jsfiddle-dev](https://jsfiddle.net/c5m1kazu/)
+
+**Expected behavior**
+
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+
+If applicable, add screenshots to help explain your problem (drag and drop the image).
+
+**Platform:**
+
+ - Device: [Desktop, Mobile]
+ - OS: [Windows, MacOS, Linux, Android, iOS]
+ - Browser: [Chrome, Firefox, Safari, Edge]
+ - Three.js version: [dev, r???]

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Help and Support
+    url: https://discourse.threejs.org/
+    about: Please use the forum if you have questions or need help.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,26 @@
+---
+name: Feature request
+about: Suggest an idea for the project.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+<!-- Ignoring this template may result in your feature request getting deleted -->
+
+**Is your feature request related to a problem? Please describe.**
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,9 @@
+Related issue: #XXXX
+
+**Description**
+
+A clear and concise description of what the problem was and how this pull request solves it.
+
+<!-- Remove the line below if is not relevant -->
+
+This contribution is funded by [Example](https://example.com).

.github/pull_request_template.md

@@ -23,7 +23,7 @@ jobs:
       - name: Install node
         uses: actions/setup-node@v1
         with:
-          node-version: 10
+          node-version: 12
       - name: Install packages
         run: npm ci
 
@@ -39,7 +39,7 @@ jobs:
       - name: Install node
         uses: actions/setup-node@v1
         with:
-          node-version: 10
+          node-version: 12
       - name: Install packages
         run: npm ci && npm ci --prefix test
       - name: Build
@@ -63,7 +63,7 @@ jobs:
       - name: Install node
         uses: actions/setup-node@v1
         with:
-          node-version: 10
+          node-version: 12
       - name: Install packages
         run: npm ci && npm ci --prefix test && sudo apt-get install xvfb
       - name: Build
@@ -81,7 +81,7 @@ jobs:
       - name: Install node
         uses: actions/setup-node@v1
         with:
-          node-version: 10
+          node-version: 12
       - name: Install packages
         run: npm ci
 

.github/workflows/ci.yml

@@ -27,11 +27,10 @@ This code creates a scene, a camera, and a geometric cube, and it adds the cube
 ```javascript
 import * as THREE from './js/three.module.js';
 
-var camera, scene, renderer;
-var geometry, material, mesh;
+let camera, scene, renderer;
+let geometry, material, mesh;
 
 init();
-animate();
 
 function init() {
 
@@ -48,23 +47,22 @@ function init() {
 
 	renderer = new THREE.WebGLRenderer( { antialias: true } );
 	renderer.setSize( window.innerWidth, window.innerHeight );
+	renderer.setAnimationLoop( animation );
 	document.body.appendChild( renderer.domElement );
 
 }
 
-function animate() {
+function animation( time ) {
 
-	requestAnimationFrame( animate );
-
-	mesh.rotation.x += 0.01;
-	mesh.rotation.y += 0.02;
+	mesh.rotation.x = time / 2000;
+	mesh.rotation.y = time / 1000;
 
 	renderer.render( scene, camera );
 
 }
 ```
 
-If everything went well, you should see [this](https://jsfiddle.net/8kubjpL5/).
+If everything went well, you should see [this](https://jsfiddle.net/yf6nks2o/).
 
 ### Cloning this repository ###