Skip to content

NewProject.md

Latest commit

 

History

History
60 lines (46 loc) · 2.82 KB

NewProject.md

File metadata and controls

60 lines (46 loc) · 2.82 KB

Adding a new project

All project types

  1. Add your new project to the Axe.Windows Solution (src\AxeWindows.sln).
  2. Before creating a pull request, verify that Visual Studio can successfully load and build the entire solution in both Debug and Release.
  3. If your project requires NuGet dependencies which need to be installed alongside it, update the section of ./src/ci/axe.windows.nuspec.

For all .NET Framework projects

  1. Right-click on the project and select Properties.
  2. In the Application tab, configure "Target Framework" to use the same .NET Framework version used by the axe.windows.core project, currently .NET Framework 4.7.1.
  3. In the build tab, set the following for both Debug and Release configurations:
    1. "Warning level" to 4.
    2. "Treat warnings as errors" to "All".

For production (not test) .NET Framework projects

  1. Add the following NuGet packages in Visual Studio to enable signing and code analysis:
    Microsoft.VisualStudioEng.MicroBuild.Core
Microsoft.CodeAnalysis.FxCopAnalyzers
  2. Close the solution and use your text editor to make the following changes to your .csproj file to properly configure the version and signing options:
    1. Add the following line alongside the existing <Compile> statements:
      <Compile Include="$(TEMP)\AxeWindowsVersionInfo.cs" />
    2. Add the following below the last ItemGroup:
    <ItemGroup>
   <DropSignedFile Include="$(TargetPath)" />
</ItemGroup>
<Import Project="..\..\build\settings.targets" />
  3. Use your text editor to make the following changes to your project's Properties\AssemblyInfo file to set the correct version:
    1. Remove the following lines, as well as the commented lines above them: 
      [assembly: AssemblyVersion("1.0.*")]
[assembly: AssemblyFileVersion("1.0.0.0")]

For test .NET Framework projects

  1. Close the solution and use your text editor to add the following line to your .csproj file to properly configure Strong Naming for your assembly:
    <Import Project="..\..\build\delaysign.targets" />
  2. Build the entire solution in both Debug and Release. Ensure that the tests are appropriately discovered in the test explorer, and that they all run successfully.

.NET Standard and .NET Core projects

For production (not test) .NET Standard/Core projects

In a text editor, add the following line:
<Import Project="..\..\build\NetStandardRelease.targets" />

For test .NET Standard/Core projects

In a text editor, add the following line:
<Import Project="..\..\build\NetStandardTest.targets" />