New package: LocalAncestry v1.0.0-DEV

[JuliaRegistrator]

• Registering package: LocalAncestry
• Repository: https://github.com/BgroveP/LocalAncestry.jl
• Created by: @BgroveP
• Version: v1.0.0-DEV
• Commit: b7c1437b2a0e08c1e547a8bf3b86669096f4a250
• Git reference: HEAD

[MasonProtter]

This package doesn't have a Readme, a description, or 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 some documentation and usage info?

[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 ❌

• Version number is not allowed to contain prerelease data

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.

[goerz]

I would also caution against starting with v1.0.0 as a version number at the project's current state. If you are following semantic versioning, a v1.0.0 version indicates the first "stable" release, which must declare a public API. In order to do that, I would generally recommend a full Documenter-based API documentation. I would also recommend setting up tests with good coverage. Without that, it is hard to determine whether changes are "breaking" or not, which SemVer would require keeping track of post-1.0 in the form of a changelog. Unless you want to polish up your project now and are quite sure that the API is stable and well-tested, my recommendation is usually for projects to start with 0.1 and then move to 1.0 as soon as they have reached the level of maturity that would warrant the label "stable".

[BgroveP]

Thank you both for your comments. I have added a public API, bumped the version down to 0.1.0, and started writing a documentation. When ready to resubmit, do I just submit as I did the first time, or is can I resubmit in another way that signals that it is a resubmission?

[goerz]

Thank you!

Yes, you resubmit the same way as for the original registration.

It would probably be a good idea to specify not just the input types of getLocalAncestries, but also the output. If you have both, since that is the only function in the package, that would then be a complete specification of the API, and you could release this as v1.0.0.

Lastly, a small note: the convention for function names in Julia is to use snake_case, not camelCase. Thus, I would recommend renaming getLocalAncestries to get_local_ancestries