Skip to content

Commit dd4835f

Browse files
Merge pull request #1277 from wilka/patch-1
Add submodule info to CONTRIBUTING.md
2 parents 9307048 + a79a447 commit dd4835f

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

.github/CONTRIBUTING.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,20 @@
2020

2121
* Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.
2222

23+
#### **Building**
24+
25+
* When first cloning the repo, make sure to run `git submodule update --init --recursive` otherwise the submodules (e.g. `shared-infrastructure`) will be missing.
26+
27+
* Run `dotnet build` in the root of the repo, or open the ImageSharp.sln file in Visual Studio and build from there.
28+
2329
#### **Running tests and Debugging**
2430

2531
* Expected test output is pulled in as a submodule from the [ImageSharp.Tests.Images repository](https://github.com/SixLabors/Imagesharp.Tests.Images/tree/master/ReferenceOutput). To succesfully run tests, make sure that you have updated the submodules!
2632
* Debugging (running tests in Debug mode) is only supported on .NET Core 2.1, because of JIT Code Generation bugs like [dotnet/coreclr#16443](https://github.com/dotnet/coreclr/issues/16443) or [dotnet/coreclr#20657](https://github.com/dotnet/coreclr/issues/20657)
2733

2834
#### **Do you have questions about consuming the library or the source code?**
2935

30-
* Ask any question about how to use ImageSharp in the [ImageSharp Gitter Chat Room](https://gitter.im/ImageSharp/General).
36+
* Ask any question about how to use ImageSharp over in the [discussions section](https://github.com/SixLabors/ImageSharp/discussions).
3137

3238
#### Code of Conduct
3339
This project has adopted the code of conduct defined by the [Contributor Covenant](https://contributor-covenant.org/) to clarify expected behavior in our community.

0 commit comments

Comments
 (0)