-
Notifications
You must be signed in to change notification settings - Fork 469
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
New package: StateSignals v0.1.0 #120374
base: master
Are you sure you want to change the base?
New package: StateSignals v0.1.0 #120374
Conversation
JuliaRegistrator
commented
Nov 29, 2024
- Registering package: StateSignals
- Repository: https://github.com/sciflydev/StateSignals.jl
- Created by: @PGimenez
- Version: v0.1.0
- Commit: d6567725f010539db7f8f7e3822bae9ea7aa6614
- Reviewed by: @PGimenez
- Reference: sciflydev/StateSignals.jl@d656772#commitcomment-149739637
UUID: cc7ea9f4-611f-50b7-86a5-d62288be5013 Repo: https://github.com/sciflydev/StateSignals.jl.git Tree: 814164b840971b10deaa8457c18d0b44cbd362da Registrator tree SHA: 17aec322677d9b81cdd6b9b9236b09a3f1374c6a
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 registrationPlease 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 registrationIf 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 Tip: You can edit blocking comments to add |
Thank you for submitting your package! 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. It seems you may have already started with setting up Documenter-based documentation. That would be an alternative to providing too much material in the README. The documentation badges in your README are currently dead, though. Can you fix those before re-registering? It would probably also be a good idea that all the other badges (Lint, Docs, Coverage) are green for the initial registration. |
I would also add that the package name is slightly too generic. What is it meant to achieve? |