{"id":21940174,"url":"https://github.com/softeq/dotnet-guidelines","last_synced_at":"2025-04-22T15:23:10.417Z","repository":{"id":44336925,"uuid":"224643371","full_name":"Softeq/dotnet-guidelines","owner":"Softeq","description":"A set of coding guidelines for C#, design principles, and layout rules.","archived":false,"fork":false,"pushed_at":"2021-02-05T11:50:33.000Z","size":95,"stargazers_count":13,"open_issues_count":10,"forks_count":1,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-03-29T16:22:38.598Z","etag":null,"topics":["code-style","csharp","dotnet","guidelines"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Softeq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-28T11:57:30.000Z","updated_at":"2023-09-08T18:00:41.000Z","dependencies_parsed_at":"2022-08-22T20:40:06.864Z","dependency_job_id":null,"html_url":"https://github.com/Softeq/dotnet-guidelines","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Softeq%2Fdotnet-guidelines","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Softeq%2Fdotnet-guidelines/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Softeq%2Fdotnet-guidelines/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Softeq%2Fdotnet-guidelines/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Softeq","download_url":"https://codeload.github.com/Softeq/dotnet-guidelines/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250265166,"owners_count":21402048,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["code-style","csharp","dotnet","guidelines"],"created_at":"2024-11-29T02:29:25.565Z","updated_at":"2025-04-22T15:23:10.376Z","avatar_url":"https://github.com/Softeq.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# C# Coding Guidelines\n## What is this?\nThis document attempts to provide guidelines (or coding standards if you like) for all versions of C# that are both valuable and pragmatic. The idea behind this document is make code style consistent across the projects and inside the projects as well and guarantee predictable code quality for Softeq customers. The Guidelines are based on [Dennis Doomen guidelines](https://github.com/dennisdoomen/CSharpGuidelines).\n\n## Rule severity\nEach rule in this document has its importance level:\n\n| Rule importance   | Description                                                                      |\n| :---------------- | :------------------------------------------------------------------------------- |\n| 1                 | Guidelines that you should never skip and should be applicable to all situations |\n| 2                 | Recommended guidelines                                                           |\n\n## Code Analysis\n\n| Icon  \t\t\t| Description                                                                      |\n| :---------------- | :------------------------------------------------------------------------------- |\n| \u003cimg src =\"Images/fullCover.png\" width=\"50\" height=\"50\"\u003e   | Fully covered by Re-sharper                                                      |\n| \u003cimg src =\"Images/partlyCover.png\" width=\"50\" height=\"50\"\u003e  | Partly covered by Re-sharper                                                     |\n|                   | If no image, rules aren't covered by Re-sharper\t\t\t\t\t\t\t\t   |\n\n## Guidelines rules naming convention\nAll rules must be named in the following format: **Meaningful title of the rule (SDSC-1234) \\[1\\]**, where \n* **SDCS** is Softeq Development CSharp abbreviation.\n* **1234** is the rule index which includes group index (12) and the rule index (34).\n* **\\[1\\]** is the rule a rule severity.\n\n## Table of contents\n* [10 Class design](10_ClassDesign.md)\n* [11 Member design](11_MemberDesign.md)\n* [12 Miscellaneous design](12_MiscellaneousDesign.md)\n* [13 Maintainability](13_Maintainability.md)\n* [14 Naming](14_Naming.md)\n* [16 Framework](16_Framework.md)\n* [17 Documentation](17_Documentation.md) \n* [18 Layout](18_Layout.md)\n* [Important resources](99_ImportantResources.md)\n* [DotSettings](SharedRules.DotSettings)\n* [Editorconfig](SharedRules.editorconfig)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsofteq%2Fdotnet-guidelines","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsofteq%2Fdotnet-guidelines","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsofteq%2Fdotnet-guidelines/lists"}