Work on Code coverage and Metadata

[kellertuer]

@lkdvos is the author entry for you correct?

Besides that this PR does

• a badge for Aqua
• a Changelog
• a small CI so we remember to always update the changelog.
• work on the remaining code coverage

I would also prefer to squash-merge PRs, is that ok?

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.57%. Comparing base (2935954) to head (fed6ced).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main      #15       +/-   ##
===========================================
+ Coverage   53.71%   99.57%   +45.86%     
===========================================
  Files           5        6        +1     
  Lines         229      235        +6     
===========================================
+ Hits          123      234      +111     
+ Misses        106        1      -105     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[kellertuer]

I think it is mainly stopping criteria tests missing. I can try to write these throughout today.

[lkdvos]

Looks good to me!
Definitely agreed on the squash merging, I also prefer that style of workflow, and then I don't have to worry about ugly commit histories in the PR branches :)

[kellertuer]

Ok. I will still try to get the stopping criteria tested here, might take about an hour or so still

[kellertuer]

One thing that is currently killing me is is_finished vs. is_finished! which seem to behave very very very very very different.

[lkdvos]

Yeah, I also noticed that. I think we can address this, but it should probably just go in a separate PR to keep things easy to discuss, so actually it might even be fine to merge this as-is and go from there?

[kellertuer]

Indeed it was just me testing with bad timing ;)

I am making progress now.

[kellertuer]

One thing for a next PR is to fix the show methods, they currently print roughly what summary prints as well, and the usual convention is, that they print a copyable constructor. But that is something for a next PR; where since we also changed quite some logic in the methods involved, leads to a breaking change soon.

But show is also not so critical for a first release, we can even do that later, and here is would be nonbreaking, since show output I would not consider something that has to stay stable.

[kellertuer]

I found the remaining bugs and added tests.

Now there is just one emit_message case that does not have code coverage, namely when called without a logger. Do you want to add a test for that still?

Besides that I just also added a spellchecker CI, but think with that this has reached a state where we can register a first version if you like.

[kellertuer]

If you do not want to cover that one missing line, we can merge this and register a first version I think.

[lkdvos]

Before registering, I would like to push a few more updates, which I can get to in a bit.
Mostly, I want to

• use ParallelTestRunner.jl, as I quite like this workflow and the uniformity of using that everywhere
• write a little bit more information on the readme

[kellertuer]

Ok. Both sound reasonable. For the parallel runner – maybe I will understand that as well then ;)