Skip to content

Conversation

bas-boop
Copy link
Member

@bas-boop bas-boop commented Mar 29, 2024

In this pull request we have:

  • New asset naming convention
  • Placed code conventions into a new file
  • Changed readme to a "home" page

The "home" page links will work after merge.

@bas-boop bas-boop added documentation Improvements or additions to documentation (and readme updates) new New feature or improvement on something labels Mar 29, 2024
@bas-boop bas-boop requested review from Tatum13 and swzwij March 29, 2024 12:27
@bas-boop bas-boop self-assigned this Mar 29, 2024
Copy link
Contributor

@swzwij swzwij left a comment

Choose a reason for hiding this comment

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

Here are the corrections for the text:

  1. Title Correction: "Most Common" under the table of contents should be "Most Common Prefixes and Suffixes" for clarity.

  2. Asset Prefixes Section:

    • "Most things are prefixed with the prefix generally being an acronym of the asset type followed by an underscore." → "Most assets are prefixed with an acronym representing the asset type, followed by an underscore."
  3. Base Asset Name Section:

    • "any asset that is part of this logical group should follow the the standard" → "any asset that is part of this logical group should follow the standard"
    • "using common sense is generally enough to warrant good asset names" → "using common sense is generally enough to ensure good asset names"
    • "you should never require a three digit variant number" → "you should never need a three-digit variant number"
    • "you can chain together variant names" → "you can chain variant names together"
  4. Examples Section:

    • "contentions" → "contents"
    • "Evil Diffuse" → "Evil_Diffuse" for consistency with other entries.
  5. Asset Name Modifiers Section:

    • "3ds Max Files" → "3ds Max Files (Meshes)" for clarity.
    • "All meshes in 3ds Max are lowercase to differentiate them from their FBX export." → "All meshes in 3ds Max are lowercase to differentiate them from their FBX exports."
    • "Animation Controller | AC_" → "Animation Controller | AC_" for alignment with other entries.
  6. Texture Packing Section:

    • "packing 4 channels of data into a texture (RGBA)" → "packing 4 channels of data into a texture (RGBA) is not recommended".
  7. Miscellaneous Section:

    • "Universal Render Pipeline Asset | URP_" → "Universal Render Pipeline Asset | URP_" for alignment with other entries.
  8. Audio Section:

    • "No prefix/suffix." → "No prefix or suffix."
  9. General:

    • Ensure consistent usage of punctuation and capitalization throughout the document.

These corrections should enhance clarity and consistency within the text.

@bas-boop bas-boop requested a review from swzwij April 23, 2024 19:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation (and readme updates) new New feature or improvement on something

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants