README.md
.NET Docs
This repository contains the conceptual documentation for .NET. The .NET documentation site is built from multiple repositories in addition to this one:
- .NET Desktop workloads
- .NET Aspire
- API reference
- .NET Compiler Platform SDK reference
- C# specification - draft
- C# Language design
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. You can read more about our procedures for classifying and resolving issues in our Issues policy topic. 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.
💜 Contribute
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 our labels and projects roadmap for help navigating the issues and projects in this repository. If your contribution includes third-party dependencies, see our guidance on using third-party dependencies.
To contribute, see:
- The .NET Contributor Guide 📒 for instructions on procedures we use.
- Issues labeled
help wanted
🏷️ for ideas. - #Hacktoberfest and Microsoft Docs 🎃 for details on our participation in the annual event.
📑 Code of conduct
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
- : Adds a comment to PRs that were not automated, but rather manually created that target the
live
branch. - : Closes stale issues that have not been updated in 180 days.
- : 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.
- : If an issue is labeled with
needs-more-info
and the op doesn't respond within 14 days, the issue is closed. - : Builds the site for the PR in context, and verifies the build reporting either,
success,
warnings
, orerror
. - : 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).