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

Inconsistencies in menu/chapter names #233

Closed
bkoelman opened this issue Feb 2, 2022 · 1 comment · Fixed by #235
Closed

Inconsistencies in menu/chapter names #233

bkoelman opened this issue Feb 2, 2022 · 1 comment · Fixed by #235

Comments

@bkoelman
Copy link
Contributor

bkoelman commented Feb 2, 2022

Some menu titles below GUIDELINES (left side of https://csharpcodingguidelines.com/) differ from the chapter titles (which are shown at the top right when clicking on that menu item).

Overall, the convention seems to be:
Menu title: "{section} ({ruleId})"
Chapter title: "{section} Guidelines"

For example:
Menu title: Class Design (AV1000)
Chapter title: Class Design Guidelines

Based on that, the following menu titles should be changed to match:

  • "Miscellaneous (AV1200)" should be: "Miscellaneous Design (AV1200)"
  • "Maintainability Guidelines (AV1500)" should be: "Maintainability (AV1500)"
  • "Naming Conventions (AV1700)" should be: "Naming (AV1700)"
  • "Performance Guidelines (AV1800)" should be: "Performance (AV1800)"
  • ".NET Framework Usage (AV2200)" should be: "Framework (AV2200)" (furthermore, the old name implies these rules apply to classic .NET Framework only and not .NET Core, which is not the case)
  • "Comments and XML Documentation (AV2300)" should be: "Documentation (AV2300)"
  • "Layout Guidelines (AV2400)" should be: "Layout (AV2400)"
  • "Resources & Articles" should be: "Links & Articles"

In the INTRODUCTION menu, item "Basic Principles" should be renamed to "Basic principles" (note the casing).

@bkoelman
Copy link
Contributor Author

bkoelman commented Feb 2, 2022

The names matter to me because they are reflected in analyzer category names and help links in https://github.com/bkoelman/CSharpGuidelinesAnalyzer, which I am updating to match with the latest guidelines version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant