|
|
@@ -26,9 +26,9 @@ As per the npm standard, ‘start’ is the place to begin the package.
|
|
|
|
|
|
npm start
|
|
|
|
|
|
-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.
|
|
|
+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.module.js’ script anytime there is a change within your three.js directory.
|
|
|
|
|
|
-The next most important script runs all the appropriate testing. The E-2-E testing is intended to be run by github actions.
|
|
|
+The next most important script runs all the appropriate testing. The E-2-E testing is intended to be run by GitHub Actions.
|
|
|
|
|
|
Run this command from the root folder to install test dependencies.
|
|
|
|
|
|
@@ -72,16 +72,12 @@ When you’ve decided to make changes, start with the following:
|
|
|
* Don't include any build files in 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. To update the docs in other languages, 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.
|
|
|
+* 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 the patch/feature, please mention it with a hash (e.g. #2774) in a commit message to get cross-reference in GitHub.
|
|
|
-* If you modify files in `examples/jsm` directory, then don't perform any changes in the `examples/js`, non-module files are auto-generated by running `npm run build-examples`.
|
|
|
-* If the end-to-end test failed in Travis and you are sure that all is correct, make a new screenshot 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
|
|
|
+* If the end-to-end test failed and you are sure that all is correct, follow the instructions it outputs.
|
|
|
+* 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 then please [convert it to a draft PR](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft).
|
|
|
|
Levi Pesin