Warning, /libraries/perceptualcolor/CONTRIBUTING.md is written in an unsupported language. File is not indexed.
0001 <!-- 0002 SPDX-FileCopyrightText: Lukas Sommer <sommerluk@gmail.com> 0003 SPDX-License-Identifier: BSD-2-Clause OR MIT 0004 --> 0005 0006 # Contributing to PerceptualColor 0007 0008 ## Merge requests 0009 0010 Merge requests can be done 0011 [at KDE’s Gitlab instance](https://invent.kde.org/libraries/perceptualcolor/). 0012 0013 This project uses CI to perform some checks on merge requests. You can also 0014 run locally most of these checks with 0015 ```shell 0016 scripts/local-ci-fast.sh 0017 scripts/local-ci-build-warnings.sh 0018 ``` 0019 and with 0020 0021 ```shell 0022 scripts/format.sh 0023 ``` 0024 you can to some adjustments automatically. Please run also 0025 ```shell 0026 scripts/update-screenshots.sh 0027 ``` 0028 before each merge request to update the screenshots. This is currently not 0029 enforced by the CI, but nevertheless important. 0030 0031 ## Local development 0032 0033 ```shell 0034 scripts/local-ci-fast.sh 0035 ``` 0036 0037 will also create API documentation. The folder `publicapi` corresponds to the 0038 [Online API documentation](https://api.kde.org/perceptualcolor/html/index.html) 0039 and contains only the public API. The folder `publicapiandinternals` however 0040 contains a complete documentation, including private members and private 0041 classes, which is very useful when working on PerceptualColor.