Skip to content
This repository was archived by the owner on Mar 24, 2023. It is now read-only.

Commit 92f4860

Browse files
divolginFrank Shotwell
authored and
Frank Shotwell
committed
Updating contributing instructions. (#763)
1 parent ff21ccf commit 92f4860

File tree

1 file changed

+22
-23
lines changed

1 file changed

+22
-23
lines changed

CONTRIBUTING.md

+22-23
Original file line numberDiff line numberDiff line change
@@ -10,36 +10,44 @@ Issues
1010
Pull Requests
1111
------------------------
1212

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.
1414

1515
Build & Run the Project
1616
------------------------
1717

1818
### Prerequisites
1919

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.
2121

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)
2526

2627
### First time build
2728

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:
2930

3031
```
31-
make build
32+
./hack/get_build_deps.sh
33+
make deps
3234
```
3335

34-
If you're planning to only work on "headless" mode, and don't need the UI built, you can just run
36+
To build ship executable, run
3537

3638
```
3739
make bin/ship
3840
```
3941

42+
To rebuild everything, including tests, run
43+
44+
```
45+
make build
46+
```
47+
4048
### Running
4149

42-
To run your locally-built copy of ship, use
50+
To run locally-built copy of ship, use
4351

4452
```
4553
./bin/ship init <chart-path>
@@ -51,17 +59,9 @@ for example,
5159
./bin/ship init github.com/helm/charts/stable/nginx-ingress
5260
```
5361

54-
### Iterating
55-
56-
You can run
57-
58-
```
59-
make build
60-
```
61-
62-
to re-build the project.
62+
### Using the UI
6363

64-
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:
6565

6666
```
6767
make -C web serve_ship
@@ -70,16 +70,15 @@ make -C web serve_ship
7070
The go binary serves the UI on `localhost:8800`, the webpack dev server will serve on `localhost:8880`.
7171

7272
### 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:
7474
```
7575
...
7676
make[1]: *** [.state/build_ship] Error 2
7777
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:
8080
```
8181
cd web
8282
rm -rf node_modules
8383
yarn
8484
```
85-

0 commit comments

Comments
 (0)