README.md

   1 # .NET Runtime
   2
   3 [![Build Status](https://dnceng.visualstudio.com/public/_apis/build/status/dotnet/runtime/runtime?branchName=master)](https://dnceng.visualstudio.com/public/_build/latest?definitionId=686&branchName=master)
   4 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dotnet/runtime)
   5
   6 This repo contains the code to build the .NET Core runtime, libraries and shared host (`dotnet`) installers for
   7 all supported platforms, as well as the sources to .NET Core runtime and libraries.
   8
   9 ## What is .NET Core?
  10
  11 Official Starting Page: https://dotnet.microsoft.com/
  12
  13 * [How to use .NET](https://docs.microsoft.com/dotnet/core/get-started) (with VS, VS Code, command-line CLI)
  14   * [Install official releases](https://dotnet.microsoft.com/download)
  15   * [Documentation](https://docs.microsoft.com/dotnet/core) (Get Started, Tutorials, Porting from .NET Framework, API reference, ...)
  16     * [Deploying apps](https://docs.microsoft.com/dotnet/core/deploying)
  17   * [Supported OS versions](https://github.com/dotnet/core/blob/master/os-lifecycle-policy.md)
  18 * [Roadmap](https://github.com/dotnet/core/blob/master/roadmap.md)
  19 * [Releases](https://github.com/dotnet/core/tree/master/release-notes)
  20
  21 ## How can I contribute?
  22
  23 We welcome contributions! Many people all over the world have helped make this project better.
  24
  25 * [Contributing](CONTRIBUTING.md) explains what kinds of changes we welcome
  26 - [Workflow Instructions](docs/workflow/README.md) explains how to build and test
  27
  28 ## Reporting security issues and security bugs
  29
  30 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).
  31
  32 Also see info about related [Microsoft .NET Core and ASP.NET Core Bug Bounty Program](https://www.microsoft.com/msrc/bounty-dot-net-core).
  33
  34 ## Filing issues
  35
  36 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 Core runtime and libraries.
  37
  38 For other issues, please use the following repos:
  39
  40 - For overall .NET Core SDK issues, file in the [dotnet/sdk](https://github.com/dotnet/sdk) repo
  41 - For ASP.NET issues, file in the [dotnet/aspnetcore](https://github.com/dotnet/aspnetcore) repo.
  42
  43 ## Useful Links
  44
  45 * [.NET Core source index](https://source.dot.net) / [.NET Framework source index](https://referencesource.microsoft.com)
  46 * [API Reference docs](https://docs.microsoft.com/dotnet/api/?view=netcore-3.0)
  47 * [.NET API Catalog](http://apisof.net) (incl. APIs from daily builds and API usage info)
  48 * [API docs writing guidelines](https://github.com/dotnet/dotnet-api-docs/wiki) - useful when writing /// comments
  49
  50 ## .NET Foundation
  51
  52 .NET Core is a [.NET Foundation](https://www.dotnetfoundation.org/projects) project.
  53
  54 There are many .NET related projects on GitHub.
  55
  56 - [.NET home repo](https://github.com/Microsoft/dotnet) - links to 100s of .NET projects, from Microsoft and the community.
  57 - [ASP.NET Core home](https://docs.microsoft.com/aspnet/core/?view=aspnetcore-3.0) - the best place to start learning about ASP.NET Core.
  58
  59 This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/) to clarify expected behavior in our community. For more information, see the [.NET Foundation Code of Conduct](http://www.dotnetfoundation.org/code-of-conduct).
  60
  61 General .NET OSS discussions: [.NET Foundation forums](https://forums.dotnetfoundation.org)
  62
  63 ## License
  64
  65 .NET (including the runtime repo) is licensed under the [MIT](LICENSE.TXT) license.