aspnetcore Documentation

1. Project Overview & Quickstart (dotnet/aspnetcore) Copy Chapter

File: README.md Copy Chapter

ASP.NET Core

ASP.NET Core is an open-source and cross-platform framework for building modern cloud-based internet-connected applications, such as web apps, IoT apps, and mobile backends. ASP.NET Core apps run on .NET, a free, cross-platform, and open-source application runtime. It was architected to provide an optimized development framework for apps that are deployed to the cloud or run on-premises. It consists of modular components with minimal overhead, so you retain flexibility while constructing your solutions. You can develop and run your ASP.NET Core apps cross-platform on Windows, Mac, and Linux. Learn more about ASP.NET Core.

Get started Copy Chapter

Follow the Getting Started instructions.

Also check out the .NET Homepage for released versions of .NET, getting started guides, and learning resources.

See the Triage Process document for more information on how we handle incoming issues.

How to engage, contribute, and give feedback Copy Chapter

Some of the best ways to contribute are to try things out, file issues, join in design conversations,
and make pull-requests.

• Download our latest daily builds
• Follow along with the development of ASP.NET Core:
  • Community Standup: The community standup is held every week and streamed live on YouTube. You can view past standups in the linked playlist.
  • Roadmap: The schedule and milestone themes for ASP.NET Core.
• Build ASP.NET Core source code
• Check out the contributing page to see the best places to log issues and start discussions.

Reporting security issues and bugs Copy Chapter

Security issues and bugs should be reported privately to the Microsoft Security Response Center (MSRC) via the MSRC Researcher Portal. You should receive a response within 24 hours. Further information can be found in the MSRC Report an Issue FAQ. You can also find these instructions in this repo's Security doc.

Also see info about related Microsoft .NET Bounty Program.

Related projects Copy Chapter

These are some other repos for related projects:

• Documentation - documentation sources for https://learn.microsoft.com/aspnet/core/
• Entity Framework Core - data access technology
• Runtime - cross-platform runtime for cloud, mobile, desktop, and IoT apps
• Razor - the Razor compiler and tooling for working with Razor syntax (.cshtml, .razor)

Code of conduct Copy Chapter

See CODE-OF-CONDUCT

Nightly builds Copy Chapter

This table includes links to download the latest builds of the ASP.NET Core Shared Framework. Also included are links to download the Windows Hosting Bundle, which includes the ASP.NET Core Shared Framework, the .NET Runtime Shared Framework, and the IIS plugin (ASP.NET Core Module). You can download the latest .NET Runtime builds here, and the latest .NET SDK builds here. If you're unsure what you need, then install the SDK; it has everything except the IIS plugin.

File: docs/README.md Copy Chapter

Contributor documentation

The primary audience for documentation in this folder is contributors to ASP.NET Core.
If you are looking for documentation on how to use ASP.NET Core, go to https://docs.asp.net.

:bulb: If you're a new contributor looking to set up the repo locally, the build from source documentation is the best place to start.

The table below outlines the different docs in this folder and what they are helpful for.

2. Official Technical Reference & Guides (dotnet/docs) Copy Chapter

.NET Docs

This repository contains the conceptual documentation for .NET. The .NET documentation site is built from multiple repositories:

• .NET docs
• ASP.NET Core docs
• .NET Desktop workloads docs
• .NET MAUI docs
• Entity Framework docs
• Community toolkit

API reference documentation is published from the following repositories:

• .NET API reference
• .NET MAUI API reference
• Android API reference
• Entity Framework 6/Core API reference
• Roslyn API reference
• Community toolkit API reference

These API reference doc repositories are public. Only some accept issues and pull requests. Others are pass-through repositories because API reference is generated directly from the /// in the product source. Some folders in dotnet-api-docs use the product repository as the source of truth.

The C# language specification documentation comes from the following two repositories:

• C# language design
• C# specification - draft

Our team's tasks are tracked in our project boards. You'll see monthly sprint projects, along with long-running projects for major documentation updates. The projects contain documentation issues across the repositories that build .NET docs. Issues are tracked in the relevant repositories. We have a large community using these resources. We make our best effort to respond to issues in a timely fashion. To create a new issue, click the "Open a documentation issue" button at the bottom of any of our published docs, or choose one of the available templates. The control at the bottom of each article automatically routes you to the correct repo and fills in some relevant information based on the article.

:purple_heart: Contribute Copy Chapter

We welcome contributions to help us improve and complete the .NET docs. This is a very large repo, covering a large area. If this is your first visit, see the Contributor guide for information on working with us. Look for issues labeled help wanted :label: for ideas to get started.

Before submitting a PR with 3rd party dependencies, see our policy on 3rd party dependencies.

We work to merge or close PRs in a timely fashion. We regularly review and approve PRs. We encourage contributors to respond to comments in a similar timely fashion. Many times, reviews identify small changes such as spelling or grammar issues, or word choice. Maintainers can accept those suggestions and merge the PR. In other situations, maintainers ask for more significant changes before a PR is ready to merge. We expect contributors to make those changes. Maintainers will help by answering questions or pointing to other resources, if needed.

We consider PRs to be abandoned when they've had no activity (either commits or discussion) in the past 30 days. Team members will close PRs that have been abandoned. Contributors can reopen and continue to work.

:bookmark_tabs: Code of conduct Copy Chapter

This project has adopted the code of conduct defined by the Contributor Covenant
to clarify expected behavior in our community. For more information, see the .NET Foundation: Code of Conduct.

:octocat: GitHub Action workflows Copy Chapter

• : Adds a comment to PRs that were not automated, but rather manually created that target the live branch.
• : Automatically approves and auto-merges PRs originating from the dependabbot[bot].
• : Creates a PR to generate the "What's new" article on the first of every month.
• : The current status for the entire repositories Markdown linter status.
• : Runs various Markdown verifications, beyond the linter, such as ensuring links and redirects are valid.
• : Builds the site for the PR in context, and verifies the build reporting either, success, warnings, or error.
• : Custom .NET build validation, locates code impacted by a PR, and builds.
• : Runs monthly, creating issues on projects that target .NET versions that are out of support.
• : Automatically updates the dependabot configuration weekly, but only if required.
• : Automatically synchronizes issues with Quest (Azure DevOps).
• : Manual bulk import of issues into Quest (Azure DevOps).