Skip to content

Latest commit

 

History

History
75 lines (47 loc) · 2.83 KB

contributing.md

File metadata and controls

75 lines (47 loc) · 2.83 KB
Raw

Set up your machine to contribute

These instructions will get you ready to contribute to this project. If you just want to use Aspire, see using-latest-daily.md.

Prepare the machine

See machine-requirements.md.

Build the repo

.\build.cmd (Windows) or .\build.sh (macOS and Linux)

Run TestShop

This will confirm that you're all set up.

If you are using Visual Studio:

  1. Open Aspire.sln
  2. Set the Startup Project to be the AppHost project (it's under \playground\TestShop). Make sure the launch profile is set to "http".
  3. F5 to debug, or Ctrl+F5 to launch without debugging.

Otherwise:

dotnet restore playground/TestShop/AppHost/AppHost.csproj
dotnet run --project playground/TestShop/AppHost/AppHost.csproj

View Dashboard

When you start the sample app in Visual Studio, it will automatically open your browser to show the dashboard.

Otherwise if you are using the command line, when you have the Aspire app running, open the dashboard URL in your browser. The URL is shown in the app's console output like this: Now listening on: http://localhost:15888. You can change the default URL in the launchSettings.json file in the AppHost project.

Localization

If you are contributing to Aspire.Dashboard, please ensure that all strings are localized. If necessary, create a new resx file under Aspire.Dashboard\Resources. To reference a string, ensure the IStringLocalizer for the resx file is injected. An example is below:

@inject IStringLocalizer<Resources.ResxFile> Loc
...
<p>@Loc[Resources.ResxFile.YourStringHere]</p>

Note that injection doesn't happen until a component's OnInitialized, so if you are referencing a string from codebehind, you must wait to do that until OnInitialized.

Components

Please check the .NET Aspire components contribution guidelines if you intend to make contributions to a new or existing .NET Aspire component.

Generating local NuGet packages

If you want to try local changes on a separate Aspire based project or solution it can be useful to generate the NuGet packages in a local folder and use it as a package source.

To do so simply execute: .\build.cmd -pack (Windows) or .\build.sh -pack (macOS and Linux)

This will generate all the packages in the folder ./artifacts/packages/Debug/Shipping. At this point from your solution folder run:

dotnet nuget add source my_aspire_folder/artifacts/packages/Debug/Shipping

Or edit the NuGet.config file and add this line to the <packageSources> list:

<add key="aspire-dev" value="my_aspire_folder/artifacts/packages/Debug/Shipping" />

Tips and known issues

Make sure you have started Docker before trying to run an Aspire app.

See the tips and known issues page.