![]() |
LibInsane 1.0.10
Cross-platform Cross-API Cross-driver Cross-image-scanner Image Scan Library
|
Any change in the code should go with corresponding changes in automated tests. Don't hesitate to add tests.
Then just run:
make
make check
make test
make doc
On Windows, there is no automated tests for WIA2 or TWAIN support (there is no test backend). But it's still worth running make test
to test all the workarounds and normalizers.
make check
and make doc
may or may not work on Windows.
Tests must all pass. The Continuous Integration is the reference. If some tests pass on your computer but not in Continous Integration, then CI is right and your changes won't be accepted.
CI works mainly with GNU/Linux. After each commit, CI will build and test Libinsane on both GNU/Linux and Windows. It will also build the documentation, run static analysis.
CI builds everything with:
-Wall -Werror
(see make
/ make build
).Therefore:
-Wall -Werror
). Documentation must be buildable as well.For C code: When coding on LibInsane, please try to stick to Linux coding style. There is only one exception, line lengths. In Libinsane, line lengths longer than 80 characters but shorter than 100 characters are tolerated.
For Python examples: Please follow the PEP8.
If you want to fix style issues, please make dedicated commits.
Please take care of either maintaining your contributions (or find someone else to do the job), or document it well enough so others can maintain it. Contributions unmaintained for too long and poorly documented will be removed.
It would be appreciated if you could leave a way to contact you in case bugs are reported. The most straightforward way is simply to put your email address in your Git commits.