Browse Source

update developing docs to remind to `make test`

Dimitri Mitropoulos 5 months ago
parent
commit
aa3ef6ff74
2 changed files with 7 additions and 2 deletions
  1. 1
    1
      CONTRIBUTING.md
  2. 6
    1
      site/get-started-developing.md

+ 1
- 1
CONTRIBUTING.md View File

@@ -58,7 +58,7 @@ This is a rough outline of how to prepare a contribution:
58 58
 Refer to the [building doc](site/building.md) to find out how to build from
59 59
 source.
60 60
 
61
-Refer to the [up-and-running with Flux Development](site/get-started-developing.md) doc for a walkthrough on developing Flux locally.
61
+Refer to the [Get Started Developing](site/get-started-developing.md) guide for a walkthrough on developing Flux locally.
62 62
 
63 63
 ### How to run the test suite
64 64
 

+ 6
- 1
site/get-started-developing.md View File

@@ -1,6 +1,6 @@
1 1
 # Get Started Developing Flux
2 2
 
3
-This tutorial is going to walk you through one possible workflow for making a small (actually, tiny) change to Flux and building and testing that change locally.
3
+This guide shows a workflow for making a small (actually, tiny) change to Flux, building and testing that change locally.
4 4
 
5 5
 > ### TL;DR
6 6
 >
@@ -39,6 +39,11 @@ Now that we know everything is working with `flux-getting-started`, we're going
39 39
     - [Docker](https://docs.docker.com/install/)
40 40
     - [Go](https://golang.org/doc/install)
41 41
 
42
+1. Configure your enviroment so you can run tests.  Run:
43
+    ```sh
44
+    make test
45
+    ```
46
+
42 47
 1. We want to make sure we're starting fresh.  Tell Minikube to clear any previously running clusters.
43 48
     ```sh
44 49
     minikube delete

Loading…
Cancel
Save