sdk/cutehmi/CONTRIBUTING.md

0001 The best way to contribute to CuteHMI is through
0002 [KDE Invent](https://invent.kde.org/) GitLab infrastructure. You will need [KDE
0003 Identity](https://identity.kde.org/) to have anything more than view-only access
0004 to the repositories. If you don't have KDE Identity you can
0005 [register](https://identity.kde.org/index.php?r=registration/index) yourself.
0006 Thereafter you simply open [new issue](https://invent.kde.org/kde/cutehmi/issues).
0007 You can use GitLab issues to report any vulnerabilities, bugs, stories or feature
0008 requests.
0009
0010 If you can't have KDE Identity for whatever reason, as a last resort, you can
0011 open an issue on Michal's private GitHub
0012 [mirror](https://github.com/michpolicht/CuteHMI/issues).
0013
0014 You may want to check [KDE contribution
0015 guidelines](https://community.kde.org/Get_Involved).
0016
0017 It may also be helpful to read [extensions README](extensions/README.md).
0018
0019 CuteHMI uses [Artistic Style](http://astyle.sourceforge.net/) to format C++
0020 code.
0021
0022 When it comes to coding conventions, [Qt Coding
0023 Conventions](https://wiki.qt.io/Coding_Conventions) are used with few
0024 exceptions.
0025 - Exceptions are allowed.
0026 - It is allowed to inherit from template classes (CuteHMI uses namespaces
0027   everywhere, so symbol clashes should not be a problem).
0028 - Whether exact or fuzzy float comparisons should be performed depends on a case
0029   (sometimes exact comparisons are desired).
0030 - It comes out acronyms in class names are not lowercased (CuteHMI, not
0031   CuteHmi).
0032
0033 You don't need to read it all in one go. Use provided links as an assist. If you
0034 have any doubts you can ask on chat or mailing list.
0035
0036 BY CONTRIBUTING YOU MUST AGREE TO RELEASE YOUR WORK UNDER THE TERMS OF LGPL 3.0
0037 LICENSE OR LATER, AND(!) MIT LICENSE.
0038
0039 Thank you for your interest in CuteHMI!
0040