From 2e76c55693c7b49c20484a99b24d0f1b3cd75e84 Mon Sep 17 00:00:00 2001 From: Wilka Hudson Date: Tue, 14 Jul 2020 20:11:29 +0100 Subject: [PATCH] Add submodule info to CONTRIBUTING.md Add a section on building locally (I missed that the submodels existed when I first tried to build it) I also changed the help link to go to the discussions section on GitHub rather than Gitter, because when I went to Gitter to ask for help I noticed the message: > I'm leaving this channel open until Friday (GMT) and then I'm removing it. I can't keep following it when there is the Discussions pages available. from @JimBobSquarePants --- .github/CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d45d98b39..346bfd534 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -20,6 +20,12 @@ * 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. +#### **Building** + + * When first cloning the repo, make sure to run `git submodule update --init --recursive` otherwise the submodules (e.g. `shared-infrastructure`) will be missing. + + * Run `dotnet build` in the root of the repo, or open the ImageSharp.sln file in Visual Studio and build from there. + #### **Running tests and Debugging** * 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! @@ -27,7 +33,7 @@ #### **Do you have questions about consuming the library or the source code?** -* Ask any question about how to use ImageSharp in the [ImageSharp Gitter Chat Room](https://gitter.im/ImageSharp/General). +* Ask any question about how to use ImageSharp over in the [discussions section](https://github.com/SixLabors/ImageSharp/discussions). #### Code of Conduct This project has adopted the code of conduct defined by the [Contributor Covenant](https://contributor-covenant.org/) to clarify expected behavior in our community.