README.md

   1 # .NET Runtime
   2
   3 [![Build Status](https://dev.azure.com/dnceng-public/public/_apis/build/status/dotnet/runtime/runtime?branchName=main)](https://dev.azure.com/dnceng-public/public/_build/latest?definitionId=129&branchName=main)
   4 [![Help Wanted](https://img.shields.io/github/issues/dotnet/runtime/help%20wanted?style=flat-square&color=%232EA043&label=help%20wanted)](https://github.com/dotnet/runtime/labels/help%20wanted)
   5 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dotnet/runtime)
   6 [![Discord](https://img.shields.io/discord/732297728826277939?style=flat-square&label=Discord&logo=discord&logoColor=white&color=7289DA)](https://aka.ms/dotnet-discord)
   7
   8 * [What is .NET?](#what-is-net)
   9 * [How can I contribute?](#how-can-i-contribute)
  10 * [Reporting security issues and security bugs](#reporting-security-issues-and-security-bugs)
  11 * [Filing issues](#filing-issues)
  12 * [Useful Links](#useful-links)
  13 * [.NET Foundation](#net-foundation)
  14 * [License](#license)
  15
  16 This repo contains the code to build the .NET runtime, libraries and shared host (`dotnet`) installers for
  17 all supported platforms, as well as the sources to .NET runtime and libraries.
  18
  19 ## What is .NET?
  20
  21 Official Starting Page: <https://dotnet.microsoft.com>
  22
  23 * [How to use .NET](https://docs.microsoft.com/dotnet/core/get-started) (with VS, VS Code, command-line CLI)
  24   * [Install official releases](https://dotnet.microsoft.com/download)
  25   * [Install daily builds](docs/project/dogfooding.md)
  26   * [Documentation](https://docs.microsoft.com/dotnet/core) (Get Started, Tutorials, Porting from .NET Framework, API reference, ...)
  27     * [Deploying apps](https://docs.microsoft.com/dotnet/core/deploying)
  28   * [Supported OS versions](https://github.com/dotnet/core/blob/main/os-lifecycle-policy.md)
  29 * [Roadmap](https://github.com/dotnet/core/blob/main/roadmap.md)
  30 * [Releases](https://github.com/dotnet/core/tree/main/release-notes)
  31
  32 ## How can I contribute?
  33
  34 We welcome contributions! Many people all over the world have helped make this project better.
  35
  36 * [Contributing](CONTRIBUTING.md) explains what kinds of contributions we welcome
  37 * [Workflow Instructions](docs/workflow/README.md) explains how to build and test
  38 * [Get Up and Running on .NET Core](docs/project/dogfooding.md) explains how to get nightly builds of the runtime and its libraries to test them in your own projects.
  39
  40 ## Reporting security issues and security bugs
  41
  42 Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) <secure@microsoft.com>. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the [Security TechCenter](https://www.microsoft.com/msrc/faqs-report-an-issue). You can also find these instructions in this repo's [Security doc](SECURITY.md).
  43
  44 Also see info about related [Microsoft .NET Core and ASP.NET Core Bug Bounty Program](https://www.microsoft.com/msrc/bounty-dot-net-core).
  45
  46 ## Filing issues
  47
  48 This repo should contain issues that are tied to the runtime, the class libraries and frameworks, the installation of the `dotnet` binary (sometimes known as the `muxer`) and installation of the .NET runtime and libraries.
  49
  50 For other issues, please file them to their appropriate sibling repos. Their respective links are described in the [config issue template doc](/.github/ISSUE_TEMPLATE/config.yml).
  51
  52 ## Useful Links
  53
  54 * [.NET Core source index](https://source.dot.net) / [.NET Framework source index](https://referencesource.microsoft.com)
  55 * [API Reference docs](https://docs.microsoft.com/dotnet/api)
  56 * [.NET API Catalog](https://apisof.net) (incl. APIs from daily builds and API usage info)
  57 * [API docs writing guidelines](https://github.com/dotnet/dotnet-api-docs/wiki) - useful when writing /// comments
  58 * [.NET Discord Server](https://aka.ms/dotnet-discord) - a place to discuss the development of .NET and its ecosystem
  59
  60 ## .NET Foundation
  61
  62 .NET Runtime is a [.NET Foundation](https://www.dotnetfoundation.org/projects) project.
  63
  64 There are many .NET related projects on GitHub.
  65
  66 * [.NET home repo](https://github.com/Microsoft/dotnet) - links to 100s of .NET projects, from Microsoft and the community.
  67 * [ASP.NET Core home](https://docs.microsoft.com/aspnet/core) - the best place to start learning about ASP.NET Core.
  68
  69 This project has adopted the code of conduct defined by the [Contributor Covenant](https://contributor-covenant.org) to clarify expected behavior in our community. For more information, see the [.NET Foundation Code of Conduct](https://www.dotnetfoundation.org/code-of-conduct).
  70
  71 General .NET OSS discussions: [.NET Foundation Discussions](https://github.com/dotnet-foundation/Home/discussions)
  72
  73 ## License
  74
  75 .NET (including the runtime repo) is licensed under the [MIT](LICENSE.TXT) license.