Add submodule info to CONTRIBUTING.md #1277

wilka · 2020-07-14T19:11:59Z

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

Prerequisites

I have written a descriptive pull-request title
I have verified that there are no overlapping pull-requests open
I have verified that I am following matches the existing coding patterns and practice as demonstrated in the repository. These follow strict Stylecop rules 👮.
I have provided test coverage for my change (where applicable)

Description

@JimBobSquarePants

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

CLAassistant · 2020-07-14T19:12:04Z

All committers have signed the CLA.

codecov · 2020-07-14T19:25:45Z

Codecov Report

Merging #1277 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1277   +/-   ##
=======================================
  Coverage   82.68%   82.68%           
=======================================
  Files         697      697           
  Lines       30589    30589           
  Branches     3460     3460           
=======================================
  Hits        25294    25294           
  Misses       4593     4593           
  Partials      702      702

Flag	Coverage Δ
#unittests	`82.68% <ø> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9307048...a79a447. Read the comment docs.

antonfirsov · 2020-07-14T22:07:07Z

.github/CONTRIBUTING.md

+
+ * 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.


Does dotnet build indeed work out of the box for ImageSharp.sln? (Not on my system for sure, but it's broken in many ways.)

Good question, I didn't try it in detail, but from a fresh clone of the repo on my machine, when running dotnet build I got this:

C:\temp\ImageSharp  master ≣  > dotnet build Microsoft (R) Build Engine version 16.6.0+5ff7b0c9e for .NET Core Copyright (C) Microsoft Corporation. All rights reserved. Determining projects to restore... Restored C:\temp\ImageSharp\src\ImageSharp\ImageSharp.csproj (in 1.47 sec). Restored C:\temp\ImageSharp\tests\ImageSharp.Tests\ImageSharp.Tests.csproj (in 1.56 sec). Restored C:\temp\ImageSharp\tests\ImageSharp.Tests.ProfilingSandbox\ImageSharp.Tests.ProfilingSandbox.csproj (in 1.73 sec). Restored C:\temp\ImageSharp\tests\ImageSharp.Benchmarks\ImageSharp.Benchmarks.csproj (in 1.78 sec). 1 of 5 projects are up-to-date for restore. MinVer: Using { Commit: ab8ab39, Tag: 'v1.0.0-rc.3', Version: 1.0.0-rc.3, Height: 3 }. MinVer: Calculated version 1.0.0-rc.3.3. MinVer: Using { Commit: ab8ab39, Tag: 'v1.0.0-rc.3', Version: 1.0.0-rc.3, Height: 3 }. MinVer: Using { Commit: ab8ab39, Tag: 'v1.0.0-rc.3', Version: 1.0.0-rc.3, Height: 3 }. MinVer: Calculated version 1.0.0-rc.3.3. MinVer: Calculated version 1.0.0-rc.3.3. MinVer: Using { Commit: ab8ab39, Tag: 'v1.0.0-rc.3', Version: 1.0.0-rc.3, Height: 3 }. MinVer: Calculated version 1.0.0-rc.3.3. MinVer: Using { Commit: ab8ab39, Tag: 'v1.0.0-rc.3', Version: 1.0.0-rc.3, Height: 3 }. MinVer: Calculated version 1.0.0-rc.3.3. MinVer: Using { Commit: ab8ab39, Tag: 'v1.0.0-rc.3', Version: 1.0.0-rc.3, Height: 3 }. MinVer: Calculated version 1.0.0-rc.3.3. ImageSharp -> C:\temp\ImageSharp\artifacts\bin\src\ImageSharp\Debug\net472\SixLabors.ImageSharp.dll ImageSharp -> C:\temp\ImageSharp\artifacts\bin\src\ImageSharp\Debug\netstandard2.0\SixLabors.ImageSharp.dll ImageSharp -> C:\temp\ImageSharp\artifacts\bin\src\ImageSharp\Debug\netcoreapp3.1\SixLabors.ImageSharp.dll ImageSharp -> C:\temp\ImageSharp\artifacts\bin\src\ImageSharp\Debug\netcoreapp2.1\SixLabors.ImageSharp.dll ImageSharp -> C:\temp\ImageSharp\artifacts\bin\src\ImageSharp\Debug\netstandard1.3\SixLabors.ImageSharp.dll ImageSharp -> C:\temp\ImageSharp\artifacts\bin\src\ImageSharp\Debug\netstandard2.1\SixLabors.ImageSharp.dll CSC : warning CS8002: Referenced assembly 'Colourful, Version=2.0.3.0, Culture=neutral, PublicKeyToken=null' does not have a strong name. [C:\temp\ImageSharp\tests\ImageSharp.Benchmarks\ImageSharp.Benchmarks.csproj] CSC : warning CS8002: Referenced assembly 'Pfim, Version=0.9.1.0, Culture=neutral, PublicKeyToken=null' does not have a strong name. [C:\temp\ImageSharp\tests\ImageSharp.Benchmarks\ImageSharp.Benchmarks.csproj] ImageSharp.Benchmarks -> C:\temp\ImageSharp\artifacts\bin\tests\ImageSharp.Benchmarks\Debug\netcoreapp3.1\ImageSharp.Benchmarks.dll ImageSharp.Tests -> C:\temp\ImageSharp\artifacts\bin\tests\ImageSharp.Tests\Debug\netcoreapp3.1\SixLabors.ImageSharp.Tests.dll ImageSharp.Tests -> C:\temp\ImageSharp\artifacts\bin\tests\ImageSharp.Tests\Debug\netcoreapp2.1\SixLabors.ImageSharp.Tests.dll CSC : warning CS8002: Referenced assembly 'Colourful, Version=2.0.3.0, Culture=neutral, PublicKeyToken=null' does not have a strong name. [C:\temp\ImageSharp\tests\ImageSharp.Benchmarks\ImageSharp.Benchmarks.csproj] CSC : warning CS8002: Referenced assembly 'Pfim, Version=0.9.1.0, Culture=neutral, PublicKeyToken=null' does not have a strong name. [C:\temp\ImageSharp\tests\ImageSharp.Benchmarks\ImageSharp.Benchmarks.csproj] ImageSharp.Benchmarks -> C:\temp\ImageSharp\artifacts\bin\tests\ImageSharp.Benchmarks\Debug\netcoreapp2.1\ImageSharp.Benchmarks.dll ImageSharp.Tests.ProfilingSandbox -> C:\temp\ImageSharp\artifacts\bin\tests\ImageSharp.Tests.ProfilingSandbox\Debug\netcoreapp2.1\win7-x64\ImageSharp.Tests.ProfilingSandbox.dll CSC : warning CS8002: Referenced assembly 'Colourful, Version=2.0.3.0, Culture=neutral, PublicKeyToken=null' does not have a strong name. [C:\temp\ImageSharp\tests\ImageSharp.Benchmarks\ImageSharp.Benchmarks.csproj] CSC : warning CS8002: Referenced assembly 'Pfim, Version=0.9.1.0, Culture=neutral, PublicKeyToken=null' does not have a strong name. [C:\temp\ImageSharp\tests\ImageSharp.Benchmarks\ImageSharp.Benchmarks.csproj] ImageSharp.Benchmarks -> C:\temp\ImageSharp\artifacts\bin\tests\ImageSharp.Benchmarks\Debug\net472\ImageSharp.Benchmarks.exe ImageSharp.Tests.ProfilingSandbox -> C:\temp\ImageSharp\artifacts\bin\tests\ImageSharp.Tests.ProfilingSandbox\Debug\netcoreapp3.1\win7-x64\ImageSharp.Tests.ProfilingSandbox.dll ImageSharp.Tests -> C:\temp\ImageSharp\artifacts\bin\tests\ImageSharp.Tests\Debug\net472\SixLabors.ImageSharp.Tests.dll ImageSharp.Tests.ProfilingSandbox -> C:\temp\ImageSharp\artifacts\bin\tests\ImageSharp.Tests.ProfilingSandbox\Debug\net472\win7-x64\ImageSharp.Tests.ProfilingSandbox.exe Build succeeded. CSC : warning CS8002: Referenced assembly 'Colourful, Version=2.0.3.0, Culture=neutral, PublicKeyToken=null' does not have a strong name. [C:\temp\ImageSharp\tests\ImageSharp.Benchmarks\ImageSharp.Benchmarks.csproj] CSC : warning CS8002: Referenced assembly 'Pfim, Version=0.9.1.0, Culture=neutral, PublicKeyToken=null' does not have a strong name. [C:\temp\ImageSharp\tests\ImageSharp.Benchmarks\ImageSharp.Benchmarks.csproj] CSC : warning CS8002: Referenced assembly 'Colourful, Version=2.0.3.0, Culture=neutral, PublicKeyToken=null' does not have a strong name. [C:\temp\ImageSharp\tests\ImageSharp.Benchmarks\ImageSharp.Benchmarks.csproj] CSC : warning CS8002: Referenced assembly 'Pfim, Version=0.9.1.0, Culture=neutral, PublicKeyToken=null' does not have a strong name. [C:\temp\ImageSharp\tests\ImageSharp.Benchmarks\ImageSharp.Benchmarks.csproj] CSC : warning CS8002: Referenced assembly 'Colourful, Version=2.0.3.0, Culture=neutral, PublicKeyToken=null' does not have a strong name. [C:\temp\ImageSharp\tests\ImageSharp.Benchmarks\ImageSharp.Benchmarks.csproj] CSC : warning CS8002: Referenced assembly 'Pfim, Version=0.9.1.0, Culture=neutral, PublicKeyToken=null' does not have a strong name. [C:\temp\ImageSharp\tests\ImageSharp.Benchmarks\ImageSharp.Benchmarks.csproj] 6 Warning(s) 0 Error(s) Time Elapsed 00:01:37.79

So it seemed to work.

I also tried dotnet test (again with no parameters) and that seemed to work as well. It ran SixLabors.ImageSharp.Tests.dll 3 times under xunit for NetCore 3.1, 2.1 and Framework 4.7.2:

ImageSharp\artifacts\...\Debug\netcoreapp3.1\SixLabors.ImageSharp.Tests.dll(.NETCoreApp,Version=v3.1) Test Run Successful. Total tests: 16748 Passed: 16732 Skipped: 16 ImageSharp\artifacts\...\Debug\netcoreapp2.1\SixLabors.ImageSharp.Tests.dll(.NETCoreApp,Version=v2.1) Test Run Successful. Total tests: 16745 Passed: 16729 Skipped: 16 ImageSharp\artifacts\...\Debug\net472\SixLabors.ImageSharp.Tests.dll(.NETFramework,Version=v4.7.2) Test Run Successful. Total tests: 16745 Passed: 16729 Skipped: 16

@JimBobSquarePants works as intended I guess. We should probably document it in the main README.MD as well.

Yep @antonfirsov that would be wise. @wilka if you could do that it would be greatly appreciated.

antonfirsov

Thanks!

antonfirsov reviewed Jul 14, 2020

View reviewed changes

antonfirsov approved these changes Jul 16, 2020

View reviewed changes

Merge branch 'master' into patch-1

a79a447

JimBobSquarePants merged commit dd4835f into SixLabors:master Jul 16, 2020

wilka deleted the patch-1 branch July 16, 2020 18:20

JimBobSquarePants added the documentation label Jul 23, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add submodule info to CONTRIBUTING.md #1277

Add submodule info to CONTRIBUTING.md #1277

wilka commented Jul 14, 2020 •

edited

CLAassistant commented Jul 14, 2020 •

edited

codecov bot commented Jul 14, 2020 •

edited

antonfirsov Jul 14, 2020

wilka Jul 14, 2020 •

edited

wilka Jul 14, 2020 •

edited

antonfirsov Jul 14, 2020 •

edited

JimBobSquarePants Jul 15, 2020

antonfirsov left a comment


		* 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.

Add submodule info to CONTRIBUTING.md #1277

Add submodule info to CONTRIBUTING.md #1277

Conversation

wilka commented Jul 14, 2020 • edited

Prerequisites

Description

CLAassistant commented Jul 14, 2020 • edited

codecov bot commented Jul 14, 2020 • edited

Codecov Report

antonfirsov Jul 14, 2020

Choose a reason for hiding this comment

wilka Jul 14, 2020 • edited

Choose a reason for hiding this comment

wilka Jul 14, 2020 • edited

Choose a reason for hiding this comment

antonfirsov Jul 14, 2020 • edited

Choose a reason for hiding this comment

JimBobSquarePants Jul 15, 2020

Choose a reason for hiding this comment

antonfirsov left a comment

Choose a reason for hiding this comment

wilka commented Jul 14, 2020 •

edited

CLAassistant commented Jul 14, 2020 •

edited

codecov bot commented Jul 14, 2020 •

edited

wilka Jul 14, 2020 •

edited

wilka Jul 14, 2020 •

edited

antonfirsov Jul 14, 2020 •

edited