Skip to content

Commit 51b5259

Browse files
authored
FIX: minor corrections/adds to contrib file
1 parent 45e5eec commit 51b5259

File tree

1 file changed

+4
-10
lines changed

1 file changed

+4
-10
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# Guide for contributors
33
Here's you can find some documentations and guidelines to contribute to the source code.
44

5-
#==============================================================
5+
---
66
# Git
77

88
### GitHub commit convetion
@@ -48,7 +48,7 @@ git add .gitmodules
4848
git commit -m "Remove a submodule name"
4949
```
5050

51-
#==============================================================
51+
---
5252
# C++
5353

5454
### Naming & synthax convention
@@ -147,13 +147,7 @@ Follow [this guide for documenting the code](https://developer.lsst.io/cpp/api-d
147147
*/
148148
```
149149

150-
151-
### Pre-Compiled headers
152-
AC uses a precompile header `aiacpch.h` to the project to shorten compilation time for headers that you rarely modify such as stdb library, opencv etc.. Add to `aiacpch.h` every big header you do not use often.
153-
Include at the very top `#include "aiacpch.h"` of every `.cpp` file.
154-
155-
156-
### Logging
150+
### Logging (TO BE UPDATED)
157151
To log use the following MACROS. All the code is contained in `Log.hpp` and `Log.cpp`.
158152
```c++
159153
AIAC_INFO("test_core_info");
@@ -171,7 +165,7 @@ The logging can be silenced by setting OFF the option in the main `CMakeLists.tx
171165
option(SILENT_LOGGING "Do not log messages in the terminal of on." ON)
172166
```
173167

174-
### CTesting
168+
### CTesting (TO BE UPDATED)
175169
When necessary, c++ testing is done by using CTest. Important/critical features (e.g., correcting functioning of graphics with OpenGL and Glfw) needs testing to be written (this is usefull for e.g., GitHub Actions). Such tests can be extracted from the main source code and integrated in a seperate section: cmake testing.
176170

177171
To add a new test do as follow.

0 commit comments

Comments
 (0)