Merge latest dev to main for a new release (v0.3.1)

.github/actions/nbmake/action.yaml

@@ -22,6 +22,7 @@ runs:
         pytest --junitxml=report-pytest-nbmake-$result.xml -vvv --nbmake "${{ inputs.dir }}"
         echo "outfile=$result" >> $GITHUB_OUTPUT
     - name: Upload the report
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         path: ./report-pytest-nbmake-${{ steps.execute.outputs.outfile }}.xml
+        name: report-pytest-nbmake-${{ steps.execute.outputs.outfile }}

.github/workflows/build.yaml

@@ -24,7 +24,7 @@ jobs:
     - name: Upload the report
       uses: actions/upload-artifact@v4
       with:
-        name: report-pytest-with-numba.xml
+        name: report-pytest-with-numba
         path: ./report-pytest-with-numba.xml
 
   tests-without-numba:
@@ -44,7 +44,7 @@ jobs:
       - name: Upload the report
         uses: actions/upload-artifact@v4
         with:
-          name: report-pytest-without-numba.xml
+          name: report-pytest-without-numba
           path: ./report-pytest-without-numba.xml
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v5
@@ -95,9 +95,10 @@ jobs:
       - name: Build the wheel
         run: python -m build --wheel
       - name: Upload the wheel
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: ./dist/*.whl
+          name: wheel
 
   build-sdist:
     name: Build sdist on latest Linux
@@ -112,6 +113,7 @@ jobs:
       - name: Build the source distribution
         run: python -m build --sdist
       - name: Upload the wheel
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: ./dist/*.tar.gz
+          name: sdist

.github/workflows/docs-preview.yaml

@@ -25,6 +25,8 @@ jobs:
     steps:
       - name: Check out the repo
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # important: gets all history and tags
       - name: Install Minterpy with docs extras
         uses: ./.github/actions/install-minterpy
         with:

.github/workflows/docs.yaml

@@ -18,6 +18,8 @@ jobs:
     steps:
       - name: Check out the repo
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # important: gets all history and tags
       - name: Install Minterpy with docs extras
         uses: ./.github/actions/install-minterpy
         with:

AUTHORS.md

@@ -2,26 +2,31 @@
 
 ## Main code development
 
-- Damar Wicaksono (HZDR/CASUS) <d.wicaksono@hzdr.de>
-- Uwe Hernandez Acosta (HZDR/CASUS) <u.hernandez@hzdr.de>
-- Sachin Krishnan Thekke Veettil (HZDR/CASUS) <s.thekke-veettil@hzdr.de>
+- [Damar Wicaksono](https://orcid.org/0000-0001-8587-7730) ([HZDR]/ [CASUS](https://www.casus.science/?page_id=4528)) <d.wicaksono@hzdr.de>
+- [Uwe Hernandez Acosta](https://orcid.org/0000-0002-6182-1481) ([HZDR]/[CASUS](https://www.casus.science/?page_id=4442)) <u.hernandez@hzdr.de>
+- [Janina Schreiber](https://orcid.org/0000-0002-8692-0822) ([HZDR]/[CASUS](https://www.casus.science/?page_id=4528)) <j.schreiber@hzdr.de>
 
 ## Mathematical foundation
 
-- Michael Hecht(HZDR/CASUS) <m.hecht@hzdr.de>
+- [Michael Hecht](https://orcid.org/0000-0001-9214-8253) ([HZDR]/[CASUS](https://www.casus.science/?page_id=4528)) <m.hecht@hzdr.de>
 
-## Former Members and Contributions
+## Former members and contributors
 
-- Jannik Michelfeit
-- Nico Hoffman (HZDR)
-- Steve Schmerler (HZDR)
-- Vidya Chandrashekar (TU Dresden)
+- [Sachin Krishnan Thekke Veettil](https://orcid.org/0000-0003-4852-2839)
+- [Jannik Kissinger](https://orcid.org/0000-0002-1819-6975)
+- [Nico Hoffman](https://scholar.google.de/citations?user=8iDQeTwAAAAJ&hl=de)
+- [Steve Schmerler](https://orcid.org/0000-0003-1354-0578) ([HZDR])
+- Vidya Chandrashekar ([TU Dresden](https://tu-dresden.de/))
 
-## Acknowledgement
+## Acknowledgements
 
-- Klaus Steiniger (HZDR)
-- Patrick Stiller (HZDR)
-- Matthias Werner (HZDR)
-- Krzysztof Gonciarz (MPI-CBG,CSBD)
-- Attila Cangi (HZDR/CASUS)
-- Michael Bussmann (HZDR/CASUS)
+- [Klaus Steiniger](https://orcid.org/0000-0001-8965-1149) ([HZDR]/[CASUS](https://www.casus.science/?page_id=4353))
+- [Patrick Stiller](https://scholar.google.com/citations?user=nOtYbWMAAAAJ&hl=de) ([HZDR])
+- Matthias Werner ([HZDR])
+- [Krzysztof Gonciarz](https://orcid.org/0000-0001-9054-8341) ([MPI-CBG]/[CSBD])
+- [Attila Cangi](https://orcid.org/0000-0001-9162-262X) ([HZDR]/[CASUS](https://www.casus.science/?page_id=4660))
+- [Michael Bussmann](https://orcid.org/0000-0002-8258-3881) ([HZDR]/[CASUS](https://www.casus.science/?page_id=4353))
+
+[HZDR]: https://www.hzdr.de
+[MPI-CBG]: https://www.mpi-cbg.de
+[CSBD]: https://www.csbdresden.de

CHANGELOG.md

@@ -1,6 +1,28 @@
 # Changelog
 
-## Version 0.3.0
+All notable changes to the Minterpy project is 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).
+
+## [Unreleased]
+
+## [Version 0.3.1] - 2025-04-30
+
+This minor release incorporates feedback from the review process of
+the Minterpy submission to the Journal of Open Source Software (JOSS).
+There are no changes to the package's functionality.
+
+### Added
+
+- Included the source code and manuscript for the JOSS paper in the repository.
+
+### Changed
+
+- Revised and updated several documentation components, including `README.md`,
+  `CONTRIBUTING.md`, and the Getting Started guides.
+
+## Version 0.3.0 - 2024-12-20
 
 ### Added
 
@@ -171,7 +193,7 @@
   coupling with the Newton polynomial class and the corresponding
   transformation class.
 
-# Version 0.2.0-alpha
+# Version 0.2.0-alpha - 2023-01-06
 
 This is the next alpha release of `minterpy`, which adds several
 new functionalities and enhances code quality and performance.
@@ -209,3 +231,6 @@ in multiple dimensions:
 This code is still highly experimental and there is no assurance,
 that neither everything works as expected,
 nor if further releases will break the current API.
+
+[Unreleased]: https://github.com/minterpy-project/minterpy/compare/main...dev
+[0.3.1]: https://github.com/minterpy-project/minterpy/compare/v0.3.0...v0.3.1