Work on Code coverage and Metadata

.github/workflows/changelog.yml

@@ -0,0 +1,12 @@
+name: Check Changelog
+on:
+  pull_request:
+
+jobs:
+  Check-Changelog:
+    name: Check Changelog Action
+    runs-on: ubuntu-latest
+    steps:
+      - uses: tarides/changelog-check-action@v3
+        with:
+          changelog: Changelog.md

Changelog.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable Changes to the Julia package `AlgorithmsInterface.jl` are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] 2026/05/01
+
+Initial release.

Project.toml

@@ -1,6 +1,6 @@
 name = "AlgorithmsInterface"
 uuid = "d1e3940c-cd12-4505-8585-b0a4b322527d"
-authors = ["Ronny Bergmann <git@ronnybergmann.net>"]
+authors = ["Ronny Bergmann <git@ronnybergmann.net>", "Lukas Devlos <ldevos98@gmail.com>"]
 version = "0.1.0"
 
 [deps]
@@ -16,4 +16,3 @@ julia = "1.10"
 
 [workspace]
 projects = ["test", "docs"]
-

Readme.md

@@ -3,7 +3,7 @@
 `AlgorithmsInterface.jl` is a Julia package to provide a common interface to run iterative tasks.
 **Algorithm** here refers to an iterative sequence of commands, that are run until a certain stopping criterion is met.
 
-[![docs][docs-dev-img]][docs-dev-url] [![CI][ci-img]][ci-url] [![runic][runic-img]][runic-url] [![codecov][codecov-img]][codecov-url]
+[![docs][docs-dev-img]][docs-dev-url] [![CI][ci-img]][ci-url] [![runic][runic-img]][runic-url] [![codecov][codecov-img]][codecov-url] [![aqua][aqua-img]][aqua-url]
 
 [docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
 [docs-dev-url]: https://JuliaManifolds.github.io/AlgorithmsInterface.jl/dev/
@@ -17,6 +17,9 @@
 [runic-img]: https://img.shields.io/badge/code_style-%E1%9A%B1%E1%9A%A2%E1%9A%BE%E1%9B%81%E1%9A%B2-black
 [runic-url]: https://github.com/fredrikekre/Runic.jl
 
+[aqua-img]: https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg
+[aqua-url]: https://github.com/JuliaTesting/Aqua.jl
+
 # Statement of need
 
 A first approach to algorithms is a simple for-loop for a maximum number of iterations.

test/newton.jl

@@ -65,4 +65,7 @@ end
     solution2 = solve(problem, algorithm2)
     @test solution2 ≈ sqrt(a)
     @test abs(solution2 - sqrt(a)) < abs(solution1 - sqrt(a))
+    state3 = initialize_state(problem, algorithm2)
+    solve!(problem, algorithm2, state3)
+    @test state3.iterate == solution2
 end

test/runtests.jl

@@ -1,22 +1,24 @@
-using SafeTestsets
+using SafeTestsets, Test
 
 # these have to be included here to make show tests behave
 using AlgorithmsInterface
 using Dates
 
-@safetestset "Newton" begin
-    include("newton.jl")
-end
+@testset "AlgorithmsInterface.jl" begin
+    @safetestset "Newton" begin
+        include("newton.jl")
+    end
 
-@safetestset "Stopping Criteria" begin
-    include("stopping_criterion.jl")
-end
+    @safetestset "Stopping Criteria" begin
+        include("stopping_criterion.jl")
+    end
 
-@safetestset "Logging Infrastructure" begin
-    include("logging.jl")
-end
+    @safetestset "Logging Infrastructure" begin
+        include("logging.jl")
+    end
 
-@safetestset "Aqua" begin
-    using AlgorithmsInterface, Aqua
-    Aqua.test_all(AlgorithmsInterface)
+    @safetestset "Aqua" begin
+        using AlgorithmsInterface, Aqua
+        Aqua.test_all(AlgorithmsInterface)
+    end
 end