Skip to content

Commit 94f825f

Browse files
committed
Fixup notes about building and testing this project.
1 parent 80d8993 commit 94f825f

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -78,25 +78,37 @@ ask the core team for their opinion on the [RabbitMQ users mailing list][rmq-use
7878

7979
### Building Source
8080

81-
To build the projects first, clone the repository. Make sure you clone the
82-
repository and its submodules:
83-
8481
It is good practice to make sure you can build the project before making any
85-
changes to confirm that your development environment is set
86-
up correctly. Verifying that the tests pass is also a good practice (see
82+
changes to confirm that your development environment is set up correctly.
83+
Verifying that the tests pass is also a good practice (see
8784
[RUNNING_TESTS.md](/RUNNING_TESTS.md)).
8885

8986
All together, this looks like:
9087

88+
* Linux
89+
9190
```shell
9291
git clone --recurse-submodules https://github.com/rabbitmq/rabbitmq-dotnet-client
9392
cd rabbitmq-dotnet-client
94-
dotnet build ./Build.csproj
95-
./.ci/ubuntu/gha-setup.sh # On any Linux distribution with Docker installed
96-
./.ci/windows/gha-setup.ps1 # On Windows
93+
94+
# On any Linux distribution with Docker installed
95+
./.ci/ubuntu/gha-setup.sh toxiproxy pull
96+
97+
make build
9798
make test
9899
```
99100

101+
* Windows
102+
103+
Note that this will _NOT_ run toxiproxy tests.
104+
105+
```powershell
106+
git clone --recurse-submodules https://github.com/rabbitmq/rabbitmq-dotnet-client
107+
cd rabbitmq-dotnet-client
108+
./.ci/windows/gha-setup.ps1 # On Windows. Note that this installs RabbitMQ
109+
.\build.ps1 -RunTests:$true
110+
```
111+
100112
### Running Tests
101113

102114
See [RUNNING_TESTS.md](/RUNNING_TESTS.md).

0 commit comments

Comments
 (0)