New package: WeberElectrodynamics v1.0.0

[JuliaRegistrator]

• Registering package: WeberElectrodynamics
• Repository: https://github.com/WeberElectrodynamics/WeberElectrodynamics.jl
• Created by: @WeberElectrodynamics
• Version: v1.0.0
• Commit: 31a8e896b36cdf5a6eb7c853e2bf409575ddd710
• Git reference: HEAD

[github-actions]

Hello, I am an automated registration bot. I help manage the registration process by checking your registration against a set of AutoMerge guidelines. If all these guidelines are met, this pull request will be merged automatically, completing your registration. It is strongly recommended to follow the guidelines, since otherwise the pull request needs to be manually reviewed and merged by a human.

1. New package registration

Please make sure that you have read the package naming guidelines.

2. AutoMerge Guidelines are all met! ✅

Your new package registration met all of the guidelines for auto-merging and is scheduled to be merged when the mandatory waiting period (3 days) has elapsed.

3. To pause or stop registration

If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text [noblock] in your comment.

Tip: You can edit blocking comments to add [noblock] in order to unblock auto-merging.

[goerz]

Thank you for submitting your package! Could you add some API documentation? In the Julia ecosystem, we strongly encourage the use of semantic versioning, and a hard requirement for a 1.0 release is that it defines a public API, so that future releases can track breaking and non-breaking changes with respect to that API. By far the best way to realize API documentation for Julia packages is to set up Documenter with @autodocs or @docs blocks, to automatically build the documentation in GitHub actions, and to deploy the result to GitHub Pages.

This would be in addition to the paper and the example notebooks included with your project. Incidentally, the link from the README to the paper does not work, since the rendered PDF isn't part of the repository. Such broken links may or may not be the result of using Claude with too little supervision. I feel compelled to point to the LLM policy for registered packages. The MD documents in the docs folder should be incorporated with the API in the Documenter-based documentation. I would link the example notebook in a more readable version (NbViewer) from the documentation as well. I would also recommend adding the "badges" you will find at the top of the README of most Julia packages to track the success of your continuous integration, and to track coverage.

Lastly – and this is the only true blocking concern: Your repository already has version tags up to v5.2.0, and including the v1.0.0 that you are submitting for registration now. In principle, one can make releases of unregistered packages, but, without registration, it becomes a little questionable what a "release" is. In any case, for registered packages, a version should be registered first, and when that version has been merged into the registry, the corresponding commit should be tagged afterwards. The TagBot action (which you have set up) is intended to handle this automatically. You should probably revert the Remove unused DOCUMENTER_KEY from TagBot workflow commit (an instance of Claude doing things without proper guidance?)

So in regard to the versioning, you have two choices:

• Resubmit the registration with a v6.0.0 version number, keeping the existing tags
• Delete all existing version tags and retrigger the registration for v1.0.0.

If you need more time to set up a proper API documentation, you could also switch to v0.1.0 instead: The project in its current form definitely meets the semantic versioning requirements for v0.1.0 (and the requirements of registered packages to be sufficiently documented for basic usage), and you could then move to v1.0.0 as soon as you are ready to declare the API "stable", with all that implies.