|
1 | | -<!-- lint disable --> |
2 | | - |
3 | | -**Documentation** |
4 | | - |
5 | 1 | [](https://cpp-ptb.readthedocs.io/en/stable/?badge=stable) |
6 | | - |
7 | | -**Cite it** |
8 | | - |
9 | 2 | [](https://doi.org/10.5281/zenodo.4007672) |
10 | | - |
11 | | -**Unit tests and coverage** |
12 | | - |
13 | 3 | [](https://github.com/cpp-lln-lab/CPP_PTB/actions) |
14 | 4 |  |
15 | | - |
16 | 5 | [](https://codecov.io/gh/cpp-lln-lab/CPP_PTB) |
17 | | - |
18 | | -**Contributors** |
19 | | - |
20 | | -<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> |
21 | 6 | [](#contributors-) |
22 | | -<!-- ALL-CONTRIBUTORS-BADGE:END --> |
23 | 7 |
|
24 | 8 | # CPP_PTB |
25 | 9 |
|
26 | | -<!-- TOC --> |
27 | | - |
28 | | -- [CPP_PTB](#cpp_ptb) |
29 | | - - [Documentation](#documentation) |
30 | | - - [Content](#content) |
31 | | - - [Code style guide](#code-style-guide) |
32 | | - - [Unit tests](#unit-tests) |
33 | | - - [Contributors ✨](#contributors-) |
34 | | - |
35 | | -<!-- /TOC --> |
36 | | - |
37 | | -<!-- lint enable --> |
| 10 | +- [CPP_PTB](#cpp_ptb) |
| 11 | + - [Documentation](#documentation) |
| 12 | + - [Content](#content) |
| 13 | + - [Contributing](#contributing) |
| 14 | + - [Contributors ✨](#contributors-) |
38 | 15 |
|
39 | 16 | This is the Crossmodal Perception and Plasticity lab (CPP) PsychToolBox (PTB) |
40 | 17 | toolbox. |
@@ -64,39 +41,16 @@ All the documentation and installtion information is accessible |
64 | 41 | └── tests # all the tests that that can be run by github actions |
65 | 42 | ``` |
66 | 43 |
|
67 | | -## Code style guide |
68 | | - |
69 | | -We use the `camelCase` to more easily differentiates our functions from the ones |
70 | | -from PTB that use a `PascalCase`. |
71 | | - |
72 | | -In practice, we use the following regular expression for function names: |
73 | | -`[a-z]+(([A-Z]|[0-9]){1}[a-z]+)*`. |
74 | | - |
75 | | -> Regular expressions look scary but are SUPER useful to sort through filenames: |
76 | | -> |
77 | | -> - A quick [intro to regular expression](https://www.rexegg.com/) |
78 | | -> |
79 | | -> - And many websites allow you to "design and test" your regular expression: |
80 | | -> - [regexper](https://regexper.com/#%5Ba-z%5D%2B%28%28%5BA-Z%5D%7C%5B0-9%5D%29%7B1%7D%5Ba-z%5D%2B%29) |
81 | | -> - ... |
82 | | -
|
83 | | -We keep the McCabe complexity below 15 as reported by the |
84 | | -[check_my_code function](https://github.com/Remi-Gau/check_my_code) or the |
85 | | -[MISS_HIT code checker](https://florianschanda.github.io/miss_hit). A couple of |
86 | | -code quality metrics are also checked automatically by MISS_HIT (avoiding |
87 | | -functions with too many nested `if` blocks). |
88 | | - |
89 | | -We use the |
90 | | -[MISS_HIT linter](https://florianschanda.github.io/miss_hit/style_checker.html) |
91 | | -to automatically fix some linting issues. |
92 | | - |
93 | | -The code style and quality is also checked during the |
94 | | -[continuous integration](.github/workflows/miss_hit.yml). |
| 44 | +## Contributing |
95 | 45 |
|
96 | | -## Unit tests |
| 46 | +Feel free to open issues to report a bug and ask for improvements. |
97 | 47 |
|
98 | | -Unit tests are run with the mox unit toolbox and automated with github action on |
99 | | -Octave. |
| 48 | +If you want to contribute, have a look at our |
| 49 | +[contributing guidelines](https://github.com/cpp-lln-lab/.github/blob/main/CONTRIBUTING.md) |
| 50 | +that are meant to guide you and help you get started. If something is not clear |
| 51 | +or you get stuck: it is more likely we did not do good enough a job at |
| 52 | +explaining things. So do not hesitate to open an issue, just to ask for |
| 53 | +clarification. |
100 | 54 |
|
101 | 55 | ## Contributors ✨ |
102 | 56 |
|
|
0 commit comments