diff options
| author |  Jeremie Guichard <djebrest@gmail.com> | 2018-04-10 09:08:46 +0200 |
|---|---|---|
| committer |  Dirk Hohndel <dirk@hohndel.org> | 2018-04-10 08:18:32 -0700 |
| commit | 65c91e833ce1e851699b161beeceebc48527e4a4 (patch) | |
| tree | 2188b5d526c9e20ba4e10e195c15f02d3c4ce89b /CONTRIBUTING.md | |
| parent | 5d96d4af0cc6702c5473383b7a7ad0be875b375b (diff) | |
| download | subsurface-65c91e833ce1e851699b161beeceebc48527e4a4.tar.gz | |
Add Coding conventions section in CodingStyle file
Add section about string manipulation
Moved some of the existing conventions into the new section:
- variable declarations
- text strings
- UI text style
Update CONTRIBUTING.md with references to CodingStyle file
Signed-off-by: Jeremie Guichard <djebrest@gmail.com>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 68ea8ca12..a923918b5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -75,6 +75,8 @@ Here is a (non exhaustive) list of Areas that can be used: * Printing * Profile +In order to make reviews simpler and have contributions merged faster in the code base, please follow Subsurface project's coding style and coding conventions described in the [CodingStyle][11] file. + [1]: http://lists.subsurface-divelog.org/cgi-bin/mailman/listinfo/subsurface [2]: http://freenode.net/ [3]: https://www.transifex.com/ @@ -85,3 +87,5 @@ Here is a (non exhaustive) list of Areas that can be used: [8]: https://subsurface-divelog.org/building/ [9]: https://gerrit-review.googlesource.com/Documentation/user-signedoffby.html [10]: https://subsurface-divelog.org/wp-content/uploads/2011/10/Screenshot-gitk-subsurface-1.png "Example with gitk" +[11]: https://github.com/Subsurface-divelog/subsurface/blob/master/CodingStyle +[12]: https://github.com/Subsurface-divelog/subsurface/blob/master/CONVENTIONS.md |