ExportXMLWordPrintableJSON

    • Type: Epic
    • Resolution: Unresolved
    • Priority: Minor - P4
    • 4.0.0
    • Affects Version/s: None
    • Component/s: None
    • None
    • Estabilish codestyle for driver
    • Dotnet Drivers
    • Not Needed
    • In Progress
    • 0
    • 0
    • 0
    • 100
    • None
    • Hide

      17/11/226

      • Done
        • Mark private fields readonly where possible
      • In progress
        • None - Pause for 2 week due to vacation.
      • Next
        • Remove member-grouping banner comments
        • Rename static fields to the s_ prefix
        • Turn the remaining agreed rules into build-enforced checks
        • Decide the scope of the AI reviewer for rules that tooling cannot check

      03/11/226

      • Done
        • Style guide written (CSHARP-6082)
        • Tooling modernized: code style checked in the build, FxCop replaced with explicit .editorconfig rules (CSHARP-6084)
        • Style rules discussed and agreed with the team (CSHARP-6083)
        • First rules enabled and applied (CSHARP-6142, CSHARP-6161)
        • Whitespace normalized across the codebase (CSHARP-6143)
        • dotnet format check added to CI (CSHARP-6147)
        • License headers, encoding and line endings made uniform and checked in CI (CSHARP-6189)
      • In progress
        • Mark private fields readonly, fix remaining else placement, record reformat commits in .git-blame-ignore-revs (CSHARP-6289, PR in review)
      • Next
        • Remove member-grouping banner comments
        • Rename static fields to the s_ prefix
        • Turn the remaining agreed rules into build-enforced checks
        • Decide the scope of the AI reviewer for rules that tooling cannot check
      Show
      17/11/226 Done Mark private fields readonly where possible In progress None - Pause for 2 week due to vacation. Next Remove member-grouping banner comments Rename static fields to the s_ prefix Turn the remaining agreed rules into build-enforced checks Decide the scope of the AI reviewer for rules that tooling cannot check 03/11/226 Done Style guide written ( CSHARP-6082 ) Tooling modernized: code style checked in the build, FxCop replaced with explicit .editorconfig rules ( CSHARP-6084 ) Style rules discussed and agreed with the team ( CSHARP-6083 ) First rules enabled and applied ( CSHARP-6142 , CSHARP-6161 ) Whitespace normalized across the codebase ( CSHARP-6143 ) dotnet format check added to CI ( CSHARP-6147 ) License headers, encoding and line endings made uniform and checked in CI ( CSHARP-6189 ) In progress Mark private fields readonly, fix remaining else placement, record reformat commits in .git-blame-ignore-revs ( CSHARP-6289 , PR in review) Next Remove member-grouping banner comments Rename static fields to the s_ prefix Turn the remaining agreed rules into build-enforced checks Decide the scope of the AI reviewer for rules that tooling cannot check
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      Summary

      Our codebase has accumulated different various code styles over many years with no single agreed reference, so the same construct is often written several different ways depending on when it was added.

      The target of this epic is creating a single human-readable style guide for the driver, and we want to enforce as many of its rules as possible automatically through tooling, so that violations break the build rather than depending on a reviewer noticing them. For the rules that can't be automated, we want an AI reviewer to check them at PR time. 

      Motivation

      Who is the affected end user?

      N/A

      How does this affect the end user?

      N/A

      How likely is it that this problem or use case will occur?

      N/A

      If the problem does occur, what are the consequences and how severe are they?

      N/A

      Is this issue urgent?

      N/A

      Is this ticket required by a downstream team?

      N/A

      Is this ticket only for tests?

      N/A

      Cast of Characters

      Engineering Lead:
      Document Author:
      POCers:
      Product Owner:
      Program Manager:
      Stakeholders:

      Channels & Docs

      Slack Channel

      [Scope Document|some.url]

      [Technical Design Document|some.url]

            Assignee:
            Ferdinando Papale
            Reporter:
            Ferdinando Papale
            None
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              26 weeks, 2 days
              None
              None