You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+8-13Lines changed: 8 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
# Contribution
2
2
## Introduction
3
3
4
-
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/)
4
+
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/)
5
5
6
6
* Install [Node.js](https://nodejs.org/)
7
7
* Install [Git](https://git-scm.com/)
@@ -26,25 +26,20 @@ As per the npm standard, ‘start’ is the place to begin the package.
26
26
27
27
npm start
28
28
29
-
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.
29
+
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 https://localhost:8080/ to check it out. It also automatically creates the `build/three.module.js` script anytime there is a change `src` directory.
30
30
31
-
The next most important script runs all the appropriate testing. The E-2-E testing is intended to be run by GitHub Actions.
31
+
Next scripts run all the appropriate testing.
32
32
33
-
Run this command from the root folder to install test dependencies.
34
-
35
-
npm install --prefix test
36
-
37
-
And run tests.
38
-
39
-
npm test
33
+
-`npm run test` - Lint testing and unit testing (individually being `npm run lint` and `npm run test-unit`)
34
+
-`npm run test-e2e` - E2E testing. This one can take quite a long time and installs ~200 MB Chromium browser - it is primarily intended to be run only by GitHub Actions
40
35
41
36
The linting is there to keep a consistent code style across 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.
42
37
43
-
Many linting errors can be fixed automatically by running
38
+
Most linting errors can be fixed automatically by running
44
39
45
-
npm lint-fix
40
+
npm run lint-fix
46
41
47
-
If you’d like to make a minified version of the build files i.e. ‘build/three.min.js’ run:
42
+
If you’d like to make a build of the source files (e.g. `build/three.module.js`) run:
0 commit comments