Skip to content

Add IDE-level linting of code style guide #301

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
May 24, 2022
Merged

Add IDE-level linting of code style guide #301

merged 3 commits into from
May 24, 2022

Conversation

mikechu-optimizely
Copy link
Contributor

Summary

  • Begin implementing style guide guidance in Microsoft Visual Studio and JetBrains Rider
  • As source code is added and maintained, we want to slowly apply the Optimizely style guide/coding practice.
  • ⚠️ Avoid instances where a code change is lost among formatting changes. (@msohailhussain let's talk on this point)

Test plan

  • Confirm .editorconfig and .sln.DotSettings are applied to other devs' IDE.
  • Confirm no changes to source code files unless explicit call to refactor/code formatter in IDE.
  • Confirm no functional side effects or breakage after applying code formatting.

Issues

  • OASIS-8305

@mikechu-optimizely mikechu-optimizely requested a review from a team as a code owner May 23, 2022 14:55
msohailhussain
msohailhussain reviewed May 24, 2022
View reviewed changes
.editorconfig
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
dotnet_style_prefer_compound_assignment = true:suggestion
dotnet_style_prefer_simplified_interpolation = true:suggestion
dotnet_style_namespace_match_folder = true:suggestion
Copy link
Contributor

Choose a reason for hiding this comment

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

eol

msohailhussain
msohailhussain reviewed May 24, 2022
View reviewed changes
.gitignore
@@ -245,3 +245,5 @@ OptimizelySDK.Package/nuget.exe
OptimizelySDK.Package/content
OptimizelySDK.Package/lib

# JetBrains
.idea/
Copy link
Contributor

Choose a reason for hiding this comment

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

eol

mnoman09
mnoman09 approved these changes May 24, 2022
View reviewed changes
Copy link
Contributor

@mnoman09 mnoman09 left a comment

Choose a reason for hiding this comment

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

Overall, LGTM

msohailhussain
msohailhussain approved these changes May 24, 2022
View reviewed changes
Copy link
Contributor

@msohailhussain msohailhussain left a comment

Choose a reason for hiding this comment

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

lgtm

@msohailhussain msohailhussain merged commit 69de0c9 into master May 24, 2022
@msohailhussain msohailhussain deleted the mike/ide-coding-standards branch May 24, 2022 20:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
2 more reviewers

@msohailhussain msohailhussain msohailhussain approved these changes

@mnoman09 mnoman09 mnoman09 approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees

@msohailhussain msohailhussain

@mikechu-optimizely mikechu-optimizely

Labels
feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mikechu-optimizely @msohailhussain @mnoman09