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

editorcofig: Adds editorcofig rules for all the VS defaults #1827

Merged
merged 4 commits into from
Sep 18, 2020

Conversation

j82w
Copy link
Contributor

@j82w j82w commented Sep 2, 2020

Pull Request Template

Description

This is adding the editor config rules that are all set as part of the VS default to ensure that personal VS configurations don't mess with the defaults.

There will be a separate follow up PR to apply the rules to the project.

Type of change

Please delete options that are not relevant.

  • [] Bug fix (non-breaking change which fixes an issue)
  • [] New feature (non-breaking change which adds functionality)
  • [] Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [] This change requires a documentation update

Closing issues

To automatically close an issue: closes #IssueNumber

@j82w j82w added the Engineering engineering improvements (CI, tests, etc.) label Sep 2, 2020
@j82w j82w self-assigned this Sep 2, 2020
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please follow the required format: "[Internal] Category: (Adds|Fixes|Refactors) Description"

Examples:
Diagnostics: Adds GetElapsedClientLatency to CosmosDiagnostics
PartitionKey: Fixes null reference when using default(PartitionKey)
[v4] Client Encryption: Refactors code to external project
[Internal] Query: Adds code generator for CosmosNumbers for easy additions in the future.

@j82w j82w changed the title editorcofig: Add editorcofig rules to match the central SDK team. editorcofig: Adds editorcofig rules to match the central SDK team. Sep 2, 2020
.editorconfig Outdated Show resolved Hide resolved
Copy link
Member

@FabianMeiswinkel FabianMeiswinkel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO suggestions / warnings are useless. The main goal for me in having automation to enforce coding-style rules is to keep them out of PR and code-review discussions. It is a waste of everyone's time to discuss whether some method name should be preceeded with "this." or not. Letting the build process protect the rules means you keep consistency and avoid that waste of time in code reviews. With making this a suggestion you either don't end-up with consistent coding style anymore or you have the discussion back in the CRs. So I am pretty strongly against these half/baked suggestion/warning levels. Either we think a rule is important for readability - then enforce it - or it isn't important and then stop even bothering about it. I can live with both clear decisions - just dislike the middle-ground, because IMO it is the worst of both worlds.

@j82w j82w requested a review from khdang as a code owner September 3, 2020 13:07
@j82w j82w changed the title editorcofig: Adds editorcofig rules to match the central SDK team. editorcofig: Adds editorcofig rules for all the VS defaults Sep 3, 2020
Copy link
Member

@ealsur ealsur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have any summary of which are the new rules introduced? Just in case some of the names are unfamiliar (I actually have no idea what some of them do).

.editorconfig Show resolved Hide resolved
@j82w j82w merged commit 40ceaff into master Sep 18, 2020
@j82w j82w deleted the users/jawilley/bug/codeAnalysis_central_sdk branch September 18, 2020 18:53
@ghost
Copy link

ghost commented Dec 15, 2021

Closing due to in-activity, pease feel free to re-open.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Engineering engineering improvements (CI, tests, etc.)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants