liz/rawTherapee
liz/rawTherapee
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Say a few words about naming "conventions" (#4290)

Browse Source
This commit is contained in:
Flössie 2018-01-26 17:31:57 +01:00
parent 24151b313a
commit 61d954e888
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -17,4 +17,10 @@ The most useful feedback is based on the latest development code, and in the cas
- Work in a new branch. Fork if necessary.
- Keep branches small so that completed and working features can be merged into the "dev" branch often, and so that they can be abandoned if they head in the wrong direction.
- Use C++11
- The naming isn't homogeneous throughout the code but here is a rough guideline:
- *Types* (classes, structs, enums, typedefs...) should be named with `UpperCamelCase`
- *Functions* and *methods* should be named with `lowerCamelCase`
- *Variables* should be either named with `lowerCamelCase` or better with `lower_underscores` to avoid conflicts
- *Enum values* should be named with `UPPER_UNDERSCORES`
- Most important: Be consistent, even when not sticking to the rules
- Code may be run through astyle version 3 or newer. If using astyle, it is important that the astyle changes go into their own commit, so that style changes are not mixed with actual code changes. Command: `astyle --options=rawtherapee.astylerc code.cc`