Skip to content

Commit c689f76

Browse files
committed
Update based on progress
Add links to PRs that map to a given project. Also, add more requirements for the templates to be followed. For some reason, Copilot doesn't want to.
1 parent bb1af4c commit c689f76

1 file changed

Lines changed: 14 additions & 2 deletions

File tree

.github/projects/EverydayCSharp-planFundamentalsRestructuring.prompt.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
- Define concepts when they are first introduced. Don't assume readers know what a "type" or "namespace" is before those concepts are covered in the proposed TOC. When defining a concept, link to articles that provide more detail. Definitions are less important for concepts that aren't related to the C# language: Remember the goal for Fundamentals is to teach readers how C# works. While we teach through examples, the libraries and packages used in the examples are less important than the language features being demonstrated. For example, when teaching about collections, it's more important to explain what a collection is and how to use them in C# than to provide an in-depth explanation of `List<T>` vs. `Dictionary<K,V>`.
1717
- Similarly, define all terms that may be unfamiliar to the reader when they are first introduced. Link to articles that provide more detail on these terms. Remember that the audience for Fundamentals articles may not be familiar with all C# terminology, or all compputer science terminology. Provide clear definitions and context.
1818
- Set the `ms.topic` metadata value in each article's YAML front matter to match the article's content type (`overview`, `tutorial`, `concept`, `how-to`, `troubleshooting`, or `reference`).
19-
- After writing content, verify the article's structure, required metadata, and sections against the template for its content type (see the [Include major topic types](EverydayCSharp-ProjectMap.md#include-major-topic-types) table for template links).
19+
- After writing content, verify the article's structure, required metadata, and sections against the template for its content type (see the [Include major topic types](EverydayCSharp-ProjectMap.md#include-major-topic-types) table for template links). This is mandatory for every article before it can be merged to ensure consistency and completeness across the Fundamentals section.
2020
- Do not add F1 or helpviewer keywords to Fundamentals articles. When pulling content from the Reference section, remove any F1 or helpviewer keywords.
2121
- When recommending a modern feature over an older alternative, always include a justification—state *why* the recommended approach is preferred. Never describe older features as obsolete or deprecated (Goal 9).
2222
- Do not add links to files that will be created in future PRs until those files are live. For example, if PR 3 creates the `fundamentals/types/enums.md` article, then earlier PRs should not link to that file until PR 3 is merged. This may require some temporary duplication of content or placeholders for links, but it will prevent broken links in merged PRs. Instead, when an article is created, add appropriate links to it in earlier articles as needed to connect the content together.
@@ -26,6 +26,8 @@
2626

2727
### PR 1 — Program structure: namespaces + preprocessor directives
2828

29+
[#52082](https://github.com/dotnet/docs/pull/52082) *Merged*
30+
2931
> ~10 files
3032
3133
1. Revise `fundamentals/program-structure/index.md` — add file-scoped namespaces, global usings as default style
@@ -37,6 +39,8 @@
3739

3840
### PR 2 — Tutorial: System.CommandLine
3941

42+
[#52592](https://github.com/dotnet/docs/pull/52592) *Merged*
43+
4044
> ~4 files
4145
4246
1. New `fundamentals/tutorials/system-commandline.md` — demonstrate `System.CommandLine` for commands, subcommands, arguments, and options
@@ -46,6 +50,8 @@
4650

4751
### PR 3 — Type system: overview, built-in types, enums
4852

53+
[#52608](https://github.com/dotnet/docs/pull/52608) *Merged*
54+
4955
> ~10 files
5056
5157
1. Revise `fundamentals/types/index.md` — value vs. reference, unified type system
@@ -55,7 +61,7 @@
5561

5662
### PR 4 — Type system: classes, structs, records
5763

58-
> ~10 files
64+
[#52605](https://github.com/dotnet/docs/pull/52605) *Merged*
5965

6066
1. Revise `fundamentals/types/classes.md` — static classes (C# 2), object/collection initializers (C# 3)
6167
2. New `fundamentals/types/structs.md` — struct design, auto-default (C# 11), parameterless constructors (C# 10), readonly members (C# 8), record structs (C# 10)
@@ -64,6 +70,8 @@
6470

6571
### PR 5 — Type system: tuples, interfaces, generics
6672

73+
[#52891](https://github.com/dotnet/docs/pull/52891) *Merged*
74+
6775
> ~10 files
6876
6977
1. Replace `fundamentals/types/anonymous-types.md``fundamentals/types/tuples.md` — merge existing tuples + deconstruct content; add inferred names (C# 7.1), tuple comparison (C# 7.3), `with` on tuples. Redirect old URL
@@ -73,6 +81,8 @@
7381

7482
### PR 6 — Type system: conversions, delegates/lambdas, records tutorial
7583

84+
[#52973](https://github.com/dotnet/docs/pull/52973) *Merged*
85+
7686
> ~10 files
7787
7888
1. New `fundamentals/types/conversions.md` — pull+revise from `programming-guide/types/casting-and-type-conversions.md` and `programming-guide/types/boxing-and-unboxing.md`. Add redirects
@@ -82,6 +92,8 @@
8292

8393
### PR 7 — Tutorial: Choosing between tuples, records, structs, and classes
8494

95+
[#53160](https://github.com/dotnet/docs/pull/53160) *In review*
96+
8597
> ~4 files
8698
8799
1. New `fundamentals/tutorials/choosing-types.md` — teach readers to decide between using tuples, defining records, defining structs or classes, and defining interfaces

0 commit comments

Comments
 (0)