Skip to content

Commit 80d8993

Browse files
author
Isaiah Inuwa
committed
docs: Add clone and build steps to contributing guide
1 parent 9380948 commit 80d8993

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,27 @@ 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+
To build the projects first, clone the repository. Make sure you clone the
82+
repository and its submodules:
83+
84+
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
87+
[RUNNING_TESTS.md](/RUNNING_TESTS.md)).
88+
89+
All together, this looks like:
90+
91+
```shell
92+
git clone --recurse-submodules https://github.com/rabbitmq/rabbitmq-dotnet-client
93+
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
97+
make test
98+
```
99+
79100
### Running Tests
80101

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

0 commit comments

Comments
 (0)