Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace "standard" with "conventions" #41520

Merged
merged 1 commit into from
Jun 21, 2024
Merged

Replace "standard" with "conventions" #41520

merged 1 commit into from
Jun 21, 2024

Conversation

BillWagner
Copy link
Member

@BillWagner BillWagner commented Jun 21, 2024

From anonymous feedback:

This article should state that C# and .NET common coding conventions are not "Code Standards" and should not be treated as such. Code standards would be ANSI, ECMA, ISO, standardized.The common .NET conventions work well for a broad extensive library of .NET API BCL calls but do not scale for a large complex business application. The conventions work against aligning the code with the business processes by emphasizing deconstructing the C# code into a large complex web of short classes and method.Code should encapsulate business logic and algorithms.

Rather than address the purpose of different rulesets, I replaced all uses of "standard" with "convention". That reinforces that these are our conventions and any customer team should define their own. Their conventions may choose to use ours as a starting point, but shouldn't feel obligated to do so.


Internal previews

📄 File 🔗 Preview link
docs/csharp/fundamentals/coding-style/coding-conventions.md Common C# code conventions

From anonymous feedback:

> This article should state that C# and .NET common coding conventions are not "Code Standards" and should not be treated as such.  Code standards would be ANSI, ECMA, ISO, standardized.The common .NET conventions work well for a broad extensive library of .NET API BCL calls but do not scale for a large complex business application.  The conventions work against aligning the code with the business processes by emphasizing deconstructing the C# code into a large complex web of short classes and method.Code should encapsulate business logic and algorithms.

Rather than address the purpose of different rulesets, I replaced all uses of "standard" with "convention". That reinforces that these are our conventions and any customer team should define their own. Their conventions may choose to use ours as a starting point, but shouldn't feel obligated to do so.
@BillWagner BillWagner merged commit b3be7f2 into main Jun 21, 2024
11 checks passed
@BillWagner BillWagner deleted the BillWagner-patch-2 branch June 21, 2024 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants