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
{{ message }}
This repository was archived by the owner on Mar 24, 2023. It is now read-only.
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+22-23
Original file line number
Diff line number
Diff line change
@@ -10,36 +10,44 @@ Issues
10
10
Pull Requests
11
11
------------------------
12
12
13
-
Before submitting a pull request, please ensure you have enabled your fork on CircleCI, so that unit and acceptance tests can be run against the request.
13
+
All pull requests must be made from forks enabled on CircleCI, so that unit and acceptance tests can be executed prior to code being merged.
14
14
15
15
Build & Run the Project
16
16
------------------------
17
17
18
18
### Prerequisites
19
19
20
-
Ensure you have (min versions to be added):
20
+
The following tools must be installed before the project can be built. The specified version are recommended.
21
21
22
-
-`yarn`
23
-
-`go`
24
-
-`node`
22
+
-`yarn` version 1.12
23
+
-`node` version 8.11
24
+
-`go` version 1.10
25
+
-`dep` version 0.5 (https://github.com/golang/dep#installation)
25
26
26
27
### First time build
27
28
28
-
The first time you build ship, you'll need to run the following
29
+
Run the following commands before building ship for the first time:
29
30
30
31
```
31
-
make build
32
+
./hack/get_build_deps.sh
33
+
make deps
32
34
```
33
35
34
-
If you're planning to only work on "headless" mode, and don't need the UI built, you can just run
For iterating on the ui, you can start a webpack development server with
64
+
A webpack development server can be started for iterating on the ui with the following command:
65
65
66
66
```
67
67
make -C web serve_ship
@@ -70,16 +70,15 @@ make -C web serve_ship
70
70
The go binary serves the UI on `localhost:8800`, the webpack dev server will serve on `localhost:8880`.
71
71
72
72
### A note on node modules
73
-
On rare occasions, you may need to refresh your node modules. If `make build`gives you an error of the following flavor:
73
+
On rare occasions, node modules may need to be refreshed. If `make build`results in an error of the following flavor:
74
74
```
75
75
...
76
76
make[1]: *** [.state/build_ship] Error 2
77
77
make: *** [build-ui] Error 2
78
-
```
79
-
and/or if `make -C web serve_ship` gives you a `Failed to compile` error, the following commands should get you back up and running. From the root of the project:
78
+
```
79
+
and/or if `make -C web serve_ship` gives results in a `Failed to compile` error, the following commands should get everything back up and running. From the root of the project:
0 commit comments