Skip to content

Commit 9464185

Browse files
author
xmik
committed
update docs on how to contribute
1 parent f600211 commit 9464185

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Dojo works on **Linux or Mac**. Dojo is continuously tested only on Linux.
3535
* [Handling signals](#handling-signals)
3636
1. [FAQ](#faq)
3737
1. [Comparison to other tools](#comparison-to-other-tools)
38-
1. [Development](#Development)
38+
1. [Contributing and Development](#contributing-and-development)
3939
1. [License](#License)
4040

4141
## Installation
@@ -867,19 +867,20 @@ Instructions how to update this project.
867867

868868
1. Create a new feature branch from the `master` branch
869869
2. Work on your changes in that feature branch. If you want, describe you changes in [CHANGELOG.md](CHANGELOG.md)
870-
3. Compile the code and run tests locally, see the [2 options](#2-options) below
870+
3. Compile the code and run tests locally, see the [2 options](#2-options-to-develop-Dojo) below
871871
4. If you are happy with the results, create a PR from your feature branch to the main branch
872872

873873
After this, someone will read your PR, merge it and ensure version bump (using `./tasks set_version`). CI pipeline will run to automatically build and test docker image, release the project and publish the docker image.
874874

875-
### 2 options
875+
### 2 options to develop Dojo
876876
You may either use Dojo to develop Dojo, or use your local environment
877877

878-
You may take a look at the [CICD pipeline config](.circleci/config.yaml) and at the [tasks](tasks) file. The tasks file has the same purpose as Makefile or Rakefile.
878+
You may take a look at the [CICD pipeline config](.circleci/config.yml) and at the [tasks](tasks) file. The tasks file has the same purpose as Makefile or Rakefile.
879879

880880
#### Option 1: Using Dojo to develop Dojo
881881
1. Please ensure you have the [runtime dependencies](#dependencies) installed
882-
2. Compile the code and run unit tests:
882+
2. Please install [Dojo](#installation)
883+
3. Compile the code and run unit tests:
883884
```
884885
$ dojo -c Dojofile.build
885886
./tasks _build
@@ -897,7 +898,7 @@ $ dojo -c Dojofile.build
897898
# or instead, if you're running on Mac: ./tasks symlink darwin
898899
```
899900

900-
3. Run end to end tests:
901+
4. Run end to end tests:
901902
```
902903
./tasks e2e ubuntu18
903904
./tasks e2e alpine
@@ -908,6 +909,7 @@ $ dojo -c Dojofile.build
908909
2. Please install the development dependencies:
909910
* Golang
910911
* Python
912+
911913
3. Now you can compile and test Dojo:
912914

913915
```

0 commit comments

Comments
 (0)