Add coding guidelines for maya-usd repository #380
Merged
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
mattyjams
approved these changes
Mar 24, 2020
doc/codingGuidelines.md
Outdated
| #include <mayaUsd/nodes/stageData.h> | ||
| ``` | ||
|
|
||
| Private project’s header files should be `#include`'d using the file name when in the same folder. Private headers may live in sub-directories, but they should never included using "._" or ".._" as part of a relative paths. For example: |
There was a problem hiding this comment.
Missing word: "should never be included"
doc/codingGuidelines.md
Outdated
| ``` | ||
|
|
||
| ### Cross-platform development | ||
| * Consult the [build.md](https://github.com/Autodesk/maya-usd/blob/dev/doc/build.md) compatibility table to ensure you use the recommended tool (i.e., dcompiler, operating system, CMake, etc.) versions. |
There was a problem hiding this comment.
Typo: compiler ("dcompiler")
doc/codingGuidelines.md
Outdated
Comment on lines
201
to
207
| * MAYA_API_VERSION is the consistent macro to test Maya version (MAYA_APP_VERSION * 10000 + MAJOR_VERSION * 100 + MINOR_VERSION) | ||
| * MAYA_APP_VERSION is available only since Maya 2019 and is a simple year number, so it is not allowed. | ||
| **UFE** | ||
| * WANT_UFE_BUILD equals 1 if UFE is found and it should be used for conditional compilation on codes depending on UFE. | ||
|
|
||
| **USD** | ||
| * USD_VERSION_NUM is the macro to test USD version (USD_MAJOR_VERSION * 10000 + USD_MINOR_VERSION * 100 + USD_PATCH_VERSION) |
There was a problem hiding this comment.
It might be good to wrap all these version variable names in backticks to make them stand out a little better in the rendered text.
doc/codingGuidelines.md
Outdated
Comment on lines
222
to
227
| * using (vs typedef) keyword | ||
| * virtual, override and final keyword | ||
| * default and delete keywords | ||
| * auto keyword | ||
| * initialization - {} | ||
| * nullptr keyword |
There was a problem hiding this comment.
Maybe wrap these C++ keywords in backticks too?
|
Thank you @mattyjams. We made a pass over it before opening PR, but you manage to find a few more typos! Good job. |
mdelasa
approved these changes
Mar 25, 2020
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.
Add document to outline c++ coding guidelines for contributions to the maya-usd project.
Clang-format, CMake and Python guidelines will follow.