Updated naming pattern used the s_ prefix for private static fields

[siyandand1]

Title: Enforce Consistent Naming for Private Static Fields

Description:

The dotnet/aspnetcore repository currently mixes underscore and PascalCase naming conventions for private static fields. To ensure code consistency and readability, we should adopt a single naming convention. Given that dotnet/runtime uses the s prefix for private static fields, I propose we align with this convention.

Changes Proposed:

Update private static fields to use the s_ prefix consistently.
Introduce a naming rule in the .editorconfig file to enforce this convention.

Rationale:
Fixes #50888

Consistency in naming conventions helps maintain readable and maintainable code. By aligning with the dotnet/runtime convention, we ensure uniformity across the broader .NET ecosystem.

Changes Made:

Renamed private static fields to use the s_ prefix.
Added a naming rule to the .editorconfig file to enforce the s_ prefix for private static fields.

[javiercn]

@siyandand1 thanks for contacting us.

This PR doesn't seem to have any issue associated with it. Please file an issue and start the discussion in the issue before making any changes. We aren't going to take changes like this without a discussion and without the team agreeing that this is the right thing to do and important to do moving forwards.

[siyandand1]

@javiercn Apologies with that: The issue being addressed was: #50888

[mkArtakMSFT]

@JamesNK can you please review this? Thanks!

[javiercn]

@mkArtakMSFT before any review happens, I think this needs discussion with the broader team.

[dotnet-policy-service]

Hey @dotnet/aspnet-build, looks like this PR is something you want to take a look at.

[mitchdenny]

@JamesNK pointed this out in the team chat.

Conceptually I don't have a problem with changing our default to align with dotnet/runtime. I think we just need to beware any unexpected consequences:

1. Is there potentially any reflection code or optimizations that might make assumptions here.
2. Is this going to introduce any pain around backporting etc?

[javiercn]

@mitchdenny I think this is a style option and we shouldn't be imposing a convention without broader discussion across the team. (Maybe through email or DoI (@wtgodbe)).

This is not a convention our team follows, and I think that's fine. It's weird that we would choose to adopt something like s_ for static fields and not m_ for member fields, and IMO it just brings another set of inconsistencies to the table.

Our convention is essentially _ for fields of the class that are not used/visible outside the class hierarchy, I don't see how we benefit from prefixing them with s, it just seems that it leaves us in no man's land, where we mix the two popular conventions and don't fully apply neither of. (and I'm not advocating for prefixing all members m_).

I don't want to turn this into a discussion, but I think it deserves more talking before we go in one direction as this break's years of muscle memory and doesn't offer any benefit beyond what _ already provides (which is scoping the results quickly for intellisense).

[captainsafia]

My two cents: I think resolving the inconsistency between PascalCase and underscore case for private static fields in the codebase is a net good. In that case, I would propose moving from PascalCase for some fields to underscore case for all fields. IMO, that solves the immediate problem of inconsistency between the two and avoids introducing a new set of issues (around member and static fields, like @javiercn mentioned above).

With that being said, it would be good to evaluate the size of the code delta associated with this change. As @mitchdenny mentioned, it'll introduce a pain around backporting. Also, I'm cautious about merging this change during the preview7/RC1 timelines which tend to be high traffic with respect to merged PRs and having to solve merge conflicts related to the rename might prove tedious.

[JamesNK]

This change (approx 400 lines) isn't large. I don't think complicating backports should be a concern. And this change is minor compared to adding nullable annotations everywhere or switching to file scoped namespaces.

@javiercn In case you missed it, I started an informal poll in the aspnetcore team chat.

[JamesNK]

This should be s_idProperty. The character after the first underscore should be lower case.

Applies to all fields.

[JamesNK]

Talked with team members offline and we'll go with s_ prefix.

[JamesNK]

Can you add this rule to the .editorconfig file in the root of the respoitory:

https://github.com/dotnet/aspire/blob/cf61a58a739f059469bcbfbff7d5121526f6fa88/.editorconfig#L67-L75

To the .editorconfig file in the root of the respoitory:

https://github.com/dotnet/aspnetcore/blob/7498cea189f5e32a11ef480729384ff6b5dc662f/.editorconfig

Try to be consistent with the location so the editorconfigs are similar.

The rule will enforce the style with an analyzer.

[dotnet-policy-service]

Looks like this PR hasn't been active for some time and the codebase could have been changed in the meantime.
To make sure no conflicting changes have occurred, please rerun validation before merging. You can do this by leaving an /azp run comment here (requires commit rights), or by simply closing and reopening.

[dotnet-policy-service]

@siyandand1 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@dotnet-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@dotnet-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@dotnet-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ),
and conveys certain license rights to the .NET Foundation ( “.NET Foundation” ) for Your contributions to
.NET Foundation open source projects. This Agreement is effective as of the latest signature date below.

1. Definitions.

“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to .NET Foundation under this Agreement.

“Project” means any of the projects owned or managed by .NET Foundation and offered under a license
approved by the Open Source Initiative (www.opensource.org).

“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”

“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.

2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.

3. Originality of Work. You represent that each of Your Submissions is entirely Your
original work. Should You wish to Submit materials that are not Your original work,
You may Submit them separately to the Project if You (a) retain all copyright and
license information that was in the materials as you received them, (b) in the
description accompanying your Submission, include the phrase "Submission
containing materials of a third party:" followed by the names of the third party and any
licenses or other restrictions of which You are aware, and (c) follow any other
instructions in the Project's written guidelines concerning Submissions.

4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.

5. Licenses.

a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly
or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable
license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform,
and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing
rights to third parties.

b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or
indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license
under Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.

c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3 ). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or
circumstances of which You later become aware that would make Your representations in this
Agreement inaccurate in any respect.

8. Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.

9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.

10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by .NET Foundation.

.NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1.