Rendered version of Coding Guidelines?

Community USD
1

It was nice to see the recent addition of Developer Coding Guidelines - however, when I was going to send this to another dev, I failed to find a rendered (ie, html) version of this - all the search terms I tried on the USD help page, for both release/24.08 and dev/24.11, came up empty.

Is this available anywhere, or should I just continue to link to the .dox file on github for now?

(Also - my search DID turn up this note about coding conventions, which should probably be updated to refer to the Coding Guidelines!)

2

Hi Paul!
The rendered version is actually part of the API documentation since it’s geared for developers :slight_smile:

Good catch on the note about coding conventions – we’re making a few more updates to that contributing page and will include a link from that section once it’s up!

Direct link to the coding guidelines plus a link to the newly added testing guidelines, too. Hope they’re helpful!
https://openusd.org/release/api/_page__coding__guidelines.html
https://openusd.org/release/api/_page__testing__guidelines.html

3

Doh, in retrospect, that’s obvious… Thanks!

4

The resources are only useful if people are able to find it :upside_down_face:; thank you for flagging it!

The links to the coding conventions and testing guidelines are on the Contributing to USD page now along with some more workflow detail :nerd_face: Hope the added info is helpful for everyone!