feat: spacing and formatting rules (coding standards) #666
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ThusSpokeNomad
requested review from
JesseOlmer,
TwoTenPvP,
jeffreyrainy,
LukeStampfli,
mattwalsh-unity,
NoelStephensUnity and
becksebenius-unity
ThusSpokeNomad
commented
Mar 25, 2021
Comment on lines
+14
to
+24
| # formatting rules | ||
| dotnet_style_qualification_for_field = false:error | ||
| dotnet_style_qualification_for_property = false:error | ||
| dotnet_style_qualification_for_method = false:error | ||
| dotnet_style_qualification_for_event = false:error | ||
| dotnet_style_predefined_type_for_locals_parameters_members = true:error | ||
| dotnet_style_predefined_type_for_member_access = true:error | ||
| dotnet_style_require_accessibility_modifiers = always:error | ||
| csharp_style_var_when_type_is_apparent = true:error | ||
| csharp_prefer_braces = true:error | ||
| csharp_using_directive_placement = outside_namespace:error |
There was a problem hiding this comment.
setting verbosity levels to "error" gives us --fix-style error ability, which basically means dotnet-format would fix them for us automatically as it did here in this PR.
com.unity.multiplayer.mlapi/Runtime/Messaging/RpcQueue/RpcQueueProcessor.cs
Show resolved
Hide resolved
com.unity.multiplayer.mlapi/Runtime/Messaging/RpcQueue/RpcQueueProcessor.cs
Show resolved
Hide resolved
NoelStephensUnity
approved these changes
Mar 25, 2021
|
So my primary question here :P is does this follow standard unity coding guidelines ? |
| @@ -76,7 +76,10 @@ public void NetworkSerialize(NetworkSerializer serializer) | |||
|
|
|||
| public void SetParamTracking(int paramIndex, bool isTracking) | |||
| { | |||
| if (paramIndex >= 32) return; | |||
| if (paramIndex >= 32) | |||
There was a problem hiding this comment.
It doesn't warn on magic numbers ? :-)
There was a problem hiding this comment.
yeah, bots and tools are not that clever yet :D
jeffreyrainy
approved these changes
Mar 25, 2021
@wackoisgod — haha, yes it does! :)
so yeah, all of the entries in |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
introducing
.editorconfigfor spacing and formatting rules, based on Unity C# coding standards.this is the first part of coding standard rules, we will also have naming standards soon (WIP).
we are planning to integrate these rules into both local (git push hooks) and repo (yamato ci/cd) pipelines.
all the changes are made by
dotnet-formattool (not by me at all, yay!) except.editorconfigfile.you can run this command manually in your local environment to get the same results:
I will follow-up with naming rules, git-push hook & script and yamato config in the future under a separate PR.