Skip to content
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: betnet v1.0.0-DEV #117198

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

JuliaRegistrator
Copy link
Contributor

  • Registering package: betnet
  • Repository: https://github.com/lliu1871/betnet
  • Created by: @lliu1871
  • Version: v1.0.0-DEV
  • Commit: 4098a16c676352d41e29b4a63008307c59edc575
  • Git reference: HEAD
  • Description: The Bayesian estimation of transmission networks

UUID: 7644471d-ba57-4356-88d5-7bc9e0d08f03
Repo: https://github.com/lliu1871/betnet.git
Tree: 65f35c37a5205e94aca990bcbbc1be92738ca7e1

Registrator tree SHA: 191228b6dd8b9d0e2965ae3e705fe54c51dcfee8
Copy link
Contributor

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 ❌

  • Name does not meet all of the following: starts with an upper-case letter, ASCII alphanumerics only, not all letters are upper-case.
  • Repo URL does not end with /name.jl.git, where name is the package name
  • 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
Copy link
Member

goerz commented Oct 13, 2024

Thank you for submitting your package! However, this does not seem ready for registration yet, or at least not as a version 1.0.

My general rule of thumb for registration of a 0.1 version is more or less

  • Must have a name that is appropriate for the scope of the package. In this case, apart from the capitalization, it might be better to go with a longer, more descriptive name like BayesianTransmissionNetworks
  • Must have a README that explains the purpose of the package and gives a basic usage example (or a link to documentation that is sufficient to figure out how to get started)

With 1.0, in addition to that,

  • Must define the stable API. That generally means complete documentation.
  • Must have tests with reasonable coverage (on the order of 80%). Otherwise, there's no way to know if the package actually implements its API correctly. Note that your tests have hard-coded paths in them that cannot work on continuous registration, so you will definitely have to work on your tests
  • Should somewhat reasonably fill the described scope of the package. No major gaps in functionality.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants