Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
10
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
Open sidebar
Ronald
Nektar
Commits
1b18e49d
Commit
1b18e49d
authored
Feb 26, 2016
by
Dave Moxey
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
More changes
parent
146a4111
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
6 additions
and
6 deletions
+6
-6
.clang-format
.clang-format
+0
-1
CONTRIBUTING.md
CONTRIBUTING.md
+6
-5
No files found.
.clang-format
View file @
1b18e49d
BasedOnStyle: LLVM
AlignAfterOpenBracket: true
AlignConsecutiveAssignments: true
IndentWidth: 4
BreakBeforeBraces: Allman
AllowShortBlocksOnASingleLine: false
...
...
CONTRIBUTING.md
View file @
1b18e49d
...
...
@@ -123,7 +123,8 @@ below this would be fantastic.
}
```
-
**
Don't use preprocessor directives and macros unless there is no viable
alternative.
**
The exception to this is header guards inside your
`.h`
files.
alternative.
**
The exception to this is header guards inside your
`.h`
files,
which you should be sure to include in any headers you contribute.
-
Use one
`.cpp`
and
`.h`
file per C++ class, and try to keep
`inline`
header
code to a minimum (unless performance is a major factor).
-
Put spaces around binary operators and constants.
...
...
@@ -131,10 +132,10 @@ below this would be fantastic.
example above).
### Variables and naming
-
Please use sensible names
!
-
Use camelCase to define your variable and function names,
e.g.
`myAwesomeVariable`
. Any
`typedef`
s, f
unction,
`class`
and
`struct`
names
should begin with capital letters, variable names should be lower case
.
-
Please use sensible names
and use camelCase as a broad naming convention.
-
Variables should start with a lowercase letter, e.g.
`myAwesomeVariable`
.
-
F
unction,
`class`
,
`struct`
and
`typedef`
names should begin with capital
letters, e.g.
`MyAwesomeFunction`
.
-
Inside classes, member variables should be prefixed with
`m_`
,
e.g.
`m_myAwesomeVariable`
.
-
Global constants used throughout the library should be prefixed with
`k`
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment