d783a8c812
* Add warning on unmaintained testing doc page * Update testing.md Some example text that seems more clear to me, but only offered as a suggestion. Feel free to adjust it or if you want to use it as-is please double check what I wrote is accurate : ) I think the useful elements are: 1. Being explicit about what workflow steps need to happen in total 2. Being explicit about which commands are covering the entire workflow and which ones are only covering a part of it 3. Show the simple "do-it-all" options first before showing more complex partial options. Glancing at the first example and blindly copying it should land in the pit of success. Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com> |
||
|---|---|---|
| .. | ||
| coding-guidelines | ||
| design | ||
| infra | ||
| issue-mappings | ||
| manpages/host | ||
| project | ||
| workflow | ||
| area-owners.md | ||
| deep-dive-blog-posts.md | ||
| issues-pr-management.md | ||
| pr-guide.md | ||
| README.md | ||
Documents Index
This repo includes several documents that explain both high-level and low-level concepts about the .NET runtime and libraries. These are very useful for contributors, to get context that can be very difficult to acquire from just reading code.
Intro to .NET
.NET is a self-contained .NET runtime and framework that implements ECMA 335. It can be (and has been) ported to multiple architectures and platforms. It support a variety of installation options, having no specific deployment requirements itself.
Getting Started
Workflow (Building, testing, benchmarking, profiling, etc.)
If you want to contribute a code change to this repo, start here.
Design Docs
The Book of the Runtime is a set of chapters that go in depth into various interesting aspects of the design of the .NET Framework.
For your convenience, here are a few quick links to popular chapters:
For additional information, see this list of blog posts that provide a 'deep-dive' into the CoreCLR source code
Coding Guidelines
- CLR Coding Guide
- CLR JIT Coding Conventions
- Cross Platform Performance and Eventing Design
- Adding New Events to the VM
- C# coding style
- Framework Design Guidelines
- Cross-Platform Guidelines
- Performance Guidelines
- Interop Guidelines
- Breaking Changes
- Breaking Change Definitions
- Breaking Change Rules
- Project Guidelines
- Adding APIs Guidelines
Project Docs
To be added. Visit the project docs folder directly meanwhile.