Software Development Practices

[mhils]

Hi @etemesi254,

First off, thank you again for your fantastic work on zune-jpeg! I'm evaluating it as a dependency currently and came across a few things that made me feel a bit uneasy:

1. Failing CI on the dev branch.
2. Releases from dirty git checkouts (see also Zune-jpeg 0.4.14 release contains binary data #247).
3. Releases with failing CI.

For example, my latest PR (#314) has apparently broken tests (tests pass locally for me), and that made it into the latest release. That does not make me confident about version updates.

Would you be generally interested in addressing these points? I'd be happy to help a bit with improving things, but if you want to keep your current workflow I don't want to waste any efforts. :)

[etemesi254]

hi
on

1. failing CI

• Some time ago I increased debug checks in some hot code, CI calls some fuzzing checks (see https://github.com/etemesi254/zune-image/blob/dev/.github/workflows/test_jpg.yml) specifically there is a check to ensure we always read a bitstream with valid bits see (https://github.com/etemesi254/zune-image/blob/dev/crates/zune-jpeg/src/bitstream.rs line 497 ) in production that works since the code after takes care for not enough bits in stream ( the shift will just shift zero and the bits left is a saturating)

But in CI the fuzzer uses debug optimized builds so it hits it it some cases I usually try to fix ( also see issues like #302), that is the only issue that causes CI failures

2. Defintely on me, should fix this one but havent had the time no

3. See 1 above

[etemesi254]

Any help is welcome

The year has been a bit busy on me but there are plans to revive the frequency next year (possibly writing a new decoder- heic perhaps) so value your help

[mhils]

Any help is welcome

Great to hear! I've opened a first PR with some nits at #319.

Some more questions:

1. Would you be interested in a CI bot that runs rustfmt? It would look like this: Add autofix.ci mhils/zune-image#1 (Disclaimer: I'm biased here because I authored that bot - feel free to disregard this suggestion)
2. What's the backstory with the main branch? Can we move dev to main?