search

llvm / clangir

A new (MLIR based) high-level IR for clang.
https://clangir.org
Other
308 stars 84 forks source link

[Documentation] Encode rules for skeleton, asserts, unrecheable, testing, etc #620

Open bcardosolopes opened 1 month ago

bcardosolopes commented 1 month ago

Inspired by @Lancern work on providing some ASM guideline goodness, I created some guidelines for auto and camelCase usage, see it here: https://llvm.github.io/clangir/GettingStarted/coding-guideline.html

However, we still need to encode the other common review items, such as OG skeleton, asserts, unrecheable, testing, etc. It'd be nice to have that.

bcardosolopes commented 1 month ago

cc: @sitio-couto @seven-mile @gitoleg @orbiri @jopperm

eZWALT commented 3 weeks ago

Inspired by @Lancern work on providing some ASM guideline goodness, I created some guidelines for auto and camelCase usage, see it here: https://llvm.github.io/clangir/GettingStarted/coding-guideline.html

However, we still need to encode the other common review items, such as OG skeleton, asserts, unrecheable, testing, etc. It'd be nice to have that.

Would it make sense If I presented a proposal of Dialect intermixing guidelines? I'm guessing it could be useful for other future contributors which for instance, might want to tackle OpenACC.

bcardosolopes commented 3 weeks ago

That'd be great