New package: RigidtyTheoryTools v0.0.1

[JuliaRegistrator]

• Registering package: RigidtyTheoryTools
• Repository: https://github.com/Saschobolt/RigidityTheoryTools.jl
• Created by: @Saschobolt
• Version: v0.0.1
• Commit: 00d979e0c48b2b8c481b9feb477449debb3ed76e
• Reviewed by: @Saschobolt
• Reference: Saschobolt/RigidityTheoryTools.jl@00d979e#commitcomment-158901132
• Release notes:

Basic Rigidity Theory tools, including frameworks, infinitesimal rigidity and pure condition of graphs.

[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 which are not met ❌

• Repo URL does not end with /name.jl.git, where name is the package name

• The following dependencies do not have a [compat] entry that is upper-bounded and only includes a finite number of breaking releases: AbstractAlgebra, BracketAlgebras, Combinatorics, GraphMakie, Graphs

  Extended explanation

  Your package has a Project.toml file which might look something like the following:

  name = "YourPackage"
  uuid = "random id"
  authors = ["Author Names"]
  version = "major.minor"
  
  [deps]
  # Package dependencies
  # ...
  
  [compat]
  # ...

  Every package listed in [deps], along with julia itself, must also be listed under [compat] (if you don't have a [compat] section, make one!). See the Pkg docs for the syntax for compatibility bounds, and this documentation for more on the kinds of compat bounds required for AutoMerge.

3. Needs action: here's what to do next

1. Please try to update your package to conform to these guidelines. The General registry's README has an FAQ that can help figure out how to do so.
2. After you have fixed the AutoMerge issues, simply retrigger Registrator, the same way you did in the initial registration. This will automatically update this pull request. You do not need to change the version number in your Project.toml file (unless the AutoMerge issue is that you skipped a version number).

If you need help fixing the AutoMerge issues, or want your pull request to be manually merged instead, please post a comment explaining what you need help with or why you would like this pull request to be manually merged. Then, send a message to the #pkg-registration channel in the public Julia Slack for better visibility.

4. 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.

[MasonProtter]

This package doesn't have a Readme, a description, tests, nor documentation, making it seem unlikely that anyone other than the author would be able to actually use it for anything.

Generally, the registry is not for personal projects and is instead for sharing software for other people to be able to actually use. If this is meant for distribution to other people, could you please add at least a README with some usage instructions?

[goerz]

Note the typo "Rigidity" → "Rigidty". But also, could you add a little bit of documentation before registering? At the very least, that would be a description of the package's purpose and a small usage example in the README. An important part of packages in General is that any potential user can figure out what the package is about and how to get started with using it. That is really difficult when there is no documentation.

In the longer term, I definitely recommend setting up a Documenter-based documentation. Before a v1.0 release, or for smaller packages that can be effectively described entirely with their README, that's not a requirement, though.

I would not recommend registering a package a v0.0.1. The minimum version of a package registration is really v0.1.0, to indicate that it's useable. Until a package is sufficiently mature to be useful to a wide audience, and if you need the package to be registered for other reasons (development workflows), you should use a LocalRegistry instead.