feat: naming rules (coding standards) #670
Merged
Conversation
This file contains hidden or 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
0xFA11
requested review from
wackoisgod,
jeffreyrainy,
LukeStampfli,
mattwalsh-unity,
NoelStephensUnity and
becksebenius-unity
0xFA11
commented
Mar 26, 2021
0xFA11
commented
Mar 26, 2021
0xFA11
commented
Mar 26, 2021
com.unity.multiplayer.mlapi/Runtime/Messaging/RpcQueue/RpcQueueContainer.cs
Show resolved
Hide resolved
0xFA11
commented
Mar 26, 2021
com.unity.multiplayer.mlapi/Runtime/Messaging/RpcQueue/RpcQueueProcessor.cs
Outdated
Show resolved
Hide resolved
0xFA11
commented
Mar 26, 2021
com.unity.multiplayer.mlapi/Tests/Runtime/BufferDataValidationComponent.cs
Show resolved
Hide resolved
jeffreyrainy
approved these changes
Mar 26, 2021
0xFA11
commented
Mar 26, 2021
Comment on lines
25
to
28
| public string m_Name; | ||
| public string m_Category; | ||
| public string Name; | ||
| public string Category; |
There was a problem hiding this comment.
0xFA11
commented
Mar 26, 2021
Comment on lines
36
to
40
| public List<MLAPIProfilerCounter> m_ChartCounters = new List<MLAPIProfilerCounter>(); | ||
| public List<MLAPIProfilerCounter> m_DetailCounters = new List<MLAPIProfilerCounter>(); | ||
| public string m_Name; | ||
| public List<MLAPIProfilerCounter> ChartCounters = new List<MLAPIProfilerCounter>(); | ||
| public List<MLAPIProfilerCounter> DetailCounters = new List<MLAPIProfilerCounter>(); | ||
| public string Name; |
There was a problem hiding this comment.
There was a problem hiding this comment.
No. This cant be done. as the comment says above it. the fields are name that way for internal serialization
0xFA11
commented
Mar 26, 2021
Comment on lines
45
to
47
| public List<MLAPIProfilerModuleData> m_Modules; | ||
| public List<MLAPIProfilerModuleData> Modules; |
There was a problem hiding this comment.
0xFA11
commented
Mar 26, 2021
0xFA11
force-pushed
the
feature/naming-rules
branch
from
9657ea8 to
17e8b2c
Compare
0xFA11
force-pushed
the
feature/naming-rules
branch
from
def95c8 to
1b00c4a
Compare
becksebenius-unity
approved these changes
Mar 29, 2021
wackoisgod
approved these changes
Mar 29, 2021
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.
Summary
continuing on
.editorconfigwith naming rules, based on Unity C# coding standards.this is the second part of coding standard rules where we apply naming conventions.
we are planning to integrate these rules into both local (git push hooks) and repo (yamato ci/cd) pipelines.
all changes in this PR are made according to errors indicated by
dotnet-formatapplying.editorconfigrules.Running Locally
you can run this command manually in your local environment to get the same results:
after running the command above:
--fix-whitespace)--fix-style error)dotnet-formatis able to format files and fix styling issues such as spaces, brackets etc.however, it is not capable of fixing name errors since they're strictly defined by the developer.
formatting and styling fixes are 100% safe, they will NEVER change the code-flow, behavior etc.
naming errors should be fixed by the developer according to Unity C# Standards, manually.
Notes
currently, this PR does NOT automate or touch anything in your local environment and/or over yamato remotely.
however, we are planning to integrate these rules into local development environment with git-push hook script and also over
developbranch remotely by integrating it into yamato ci/cd as an extra step in the testing pipeline.we will have discussions about these future steps with Core SDK team and I will follow-up with separate PRs.