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: BenchmarkFreeFermions v1.0.0 #117244

Conversation

JuliaRegistrator
Copy link
Contributor

@JuliaRegistrator JuliaRegistrator commented Oct 14, 2024

Copy link
Contributor

github-actions bot commented Oct 14, 2024

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.

UUID: 5b68a00d-ca4d-4b58-ab0c-dc082ade624e
Repo: https://github.com/Qiaoyi-Li/BenchmarkFreeFermions.jl.git
Tree: ecafb8656ca3c62db30f39399fdcb16e7c355ff5

Registrator tree SHA: 17aec322677d9b81cdd6b9b9236b09a3f1374c6a
@JuliaRegistrator JuliaRegistrator force-pushed the registrator-benchmarkfreefermions-5b68a00d-v1.0.0-c9445ce05f branch from 8be8d29 to 671ccc5 Compare October 14, 2024 14:20
@goerz
Copy link
Member

goerz commented Oct 15, 2024

Thank you for submitting your package! However, please make sure to add some 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.

For a version 1.0, there would be additional requirements:

  • 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
  • Should somewhat reasonably fill the described scope of the package. No major gaps in functionality.

You probably want to register at v0.1, not v1.0

@goerz
Copy link
Member

goerz commented Oct 15, 2024

Closing in favor of #117300

@goerz goerz closed this Oct 15, 2024
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.

2 participants