Skip to content

Commit 9257dd6

Browse files
authored
CONTRIBUTING.md: added sections about source TODOs and simplecpp [skip ci] (#7815)
1 parent 78f5c25 commit 9257dd6

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Note: Usually you can run the CI on your own fork to verify that it passes befor
3434

3535
Cppcheck is tracking its issues at https://trac.cppcheck.net.
3636

37+
The tickets are not really prioritized (except for non-synthetic crashing issues) but of most interest are the following types of tickets.
38+
3739
[False Positives](https://trac.cppcheck.net/query?status=accepted&status=assigned&status=new&status=reopened&component=False+positive&col=id&col=summary&col=status&col=component&col=type&col=priority&col=milestone&order=priority)
3840

3941
Since Cppcheck aims to be low on false positives, these kind of issues are obviously of the highest priority.
@@ -44,6 +46,18 @@ Changes might lead to fewer findings being reported. In very few cases this migh
4446

4547
[Other Defects](https://trac.cppcheck.net/query?status=accepted&status=assigned&status=new&status=reopened&type=defect&component=!False+positive&col=id&col=summary&col=type&col=status&col=component&col=priority&col=milestone&order=priority)
4648

49+
Note: If you start working on ticket, please assign yourself or request to be.
50+
51+
## Source TODOs
52+
53+
There are also various source-level TODOs. These might be related to already tracked issues (even if not explicitly noted) but may also be just exist exploratively, have even been added overzealously or might even be outdated.
54+
55+
So if you start spending a lot of time on these, you might want to get into touch before proceeding further.
56+
57+
## simplecpp
58+
59+
At its core Cppcheck is relying on the `simplecpp` library which is a preprocessor implementation which was spun off into its [separate project](https://github.com/danmar/simplecpp) with its own [bug tracker](https://github.com/danmar/simplecpp/issues). This is also maintained by the Cppcheck developers and contributions to it are also welcome.
60+
4761
## Translations
4862

4963
We are also maintaining various translations for `cppcheck-gui`.

0 commit comments

Comments
 (0)