Skip to content

Commit acb3515

Browse files
Isaiah Inuwalukebakken
Isaiah Inuwa
authored andcommitted
docs: Add clone and build steps to contributing guide
1 parent 9380948 commit acb3515

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,39 @@ Here's the recommended workflow:
7676
If what you are going to work on is a substantial change, please first
7777
ask the core team for their opinion on the [RabbitMQ users mailing list][rmq-users].
7878

79+
### Building Source
80+
81+
It is good practice to make sure you can build the project before making any
82+
changes to confirm that your development environment is set up correctly.
83+
Verifying that the tests pass is also a good practice (see
84+
[RUNNING_TESTS.md](/RUNNING_TESTS.md)).
85+
86+
All together, this looks like:
87+
88+
* Linux
89+
90+
```shell
91+
git clone --recurse-submodules https://github.com/rabbitmq/rabbitmq-dotnet-client
92+
cd rabbitmq-dotnet-client
93+
94+
# On any Linux distribution with Docker installed
95+
./.ci/ubuntu/gha-setup.sh toxiproxy pull
96+
97+
make build
98+
make test
99+
```
100+
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+
79112
### Running Tests
80113

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

0 commit comments

Comments
 (0)