summaryrefslogtreecommitdiff
path: root/CONTRIBUTION.md
diff options
context:
space:
mode:
authorEllie Hermaszewska <ellieh@nvidia.com>2024-11-20 01:08:20 +0800
committerGitHub <noreply@github.com>2024-11-19 09:08:20 -0800
commit0bf6a668208c65c980648fbe74a8c0a7bf4ded77 (patch)
tree02e3a58af7561daed342c1362aef8b5aaad8e489 /CONTRIBUTION.md
parenta50de6bd32de1b064874480a2528fc994597f7ac (diff)
Markdown emphasis corrections (#5588)
* Add markdown formatting to extras/formatting.sh * Correct formatting in markdown * Warn on unrecognized argument in formatting script * Print all diffs in formatting script * Correct markdown emph formatting * Don't format markdown by default --------- Co-authored-by: Yong He <yonghe@outlook.com>
Diffstat (limited to 'CONTRIBUTION.md')
-rw-r--r--CONTRIBUTION.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md
index 279faff3c..69e7dab4a 100644
--- a/CONTRIBUTION.md
+++ b/CONTRIBUTION.md
@@ -243,7 +243,7 @@ Here are a few highlights
1. Don't use the STL containers, iostreams, or the built-in C++ RTTI system.
1. Don't use the C++ variants of C headers (e.g., use `<stdio.h>` instead of `<cstdio>`).
1. Don't use exceptions for non-fatal errors (and even then support a build flag to opt out of exceptions).
-1. Types should use UpperCamelCase, values should use lowerCamelCase, and macros should use SCREAMING_SNAKE_CASE with a prefix `SLANG_`.
+1. Types should use UpperCamelCase, values should use lowerCamelCase, and macros should use `SCREAMING_SNAKE_CASE` with a prefix `SLANG_`.
1. Global variables should have a `g` prefix, non-const static class members can have an `s` prefix, constant data (in the sense of static const) should have a `k` prefix, and an `m_` prefix on member variables and a `_` prefix on member functions are allowed.
1. Prefixes based on types (e.g., p for pointers) should never be used.
1. In function parameter lists, an `in`, `out`, or `io` prefix can be added to a parameter name to indicate whether a pointer/reference/buffer is intended to be used for input, output, or both input and output.