Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
20 lines (15 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

20 lines (15 loc) · 1.46 KB
Raw

Contributing

All contributions that furthers this project's objective are welcome. As of right now, this project needs quantitative testing of generated QR codes.

How to contribute with testing:

  1. Build the code with make debug and run with -g 3;
  2. Generate at least ten QR codes and try to scan it with your mobile device, try edge cases, like switching subsets, different EC levels, forcing Version (except forcing mask);
  3. Open an issue in this repo with your results (even if all scans succeeded).

How to contribute with code:

  1. Before opening any PR, create an issue discussing your proposed changes and why they are necessary (e.g. better design pattern);
  2. Before commiting code, make sure to run it through Valgrind and Cppcheck;
  3. Unless requiring change, use clang with gnu11 standard (i.e. c11 with GNU extensions).
  4. Build on Windows and Linux (must compile on amd64, others are optional) before pushing the code.

Maintainer's notes

  • Bitmap and SVG will be the only output formats supported. Monochrome bitmaps are packed (not compressed) into bits, but rows are padded to 32-bit longs. Still, it keeps the raster data quite small while avoiding compression. SVGs can be modified to change background/foreground color (and scaling beyond -s option compared to bitmaps).
  • Kanji encoding is not likely to be supported in the future, even though it is part of the ISO standard.