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: QuantumNPA v0.1.0 #120376

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

Conversation

JuliaRegistrator
Copy link
Contributor

@JuliaRegistrator JuliaRegistrator commented Nov 29, 2024

Copy link
Contributor

github-actions bot commented Nov 29, 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.

@ewoodhead
Copy link

//

UUID: 5cd12e4b-1487-4eb2-a245-40f3146b84a8
Repo: https://github.com/ewoodhead/QuantumNPA.jl.git
Tree: c8686703eb79fa4ffe921d329ed4eaa0178f3f83

Registrator tree SHA: 17aec322677d9b81cdd6b9b9236b09a3f1374c6a
@JuliaRegistrator JuliaRegistrator force-pushed the registrator-quantumnpa-5cd12e4b-v0.1.0-4964054d3f branch from b8be3be to 1106f30 Compare November 29, 2024 15:56
JuliaRegistrator referenced this pull request in ewoodhead/QuantumNPA.jl Nov 29, 2024
@JuliaTagBot JuliaTagBot added the AutoMerge: last run blocked by comment PR blocked by one or more comments lacking the string [noblock]. label Nov 29, 2024
@goerz
Copy link
Member

goerz commented Nov 29, 2024

Thank you for submitting your package! However, could you add a little bit more background to the README? I work in quantum physics, and without googling around a little, I had no idea what "NPA" is. For packages registered in General, we would want to make sure that someone coming across the README of your package would find it relatively easy to figure out what the package does and how to get started with using it. So it's best to assume that someone coming across your README is not already in your exact field and needs a bit of introduction. Avoid acronyms like NPA and CHSH without explaining them.

Which also raises the question of the package name. As explained in the naming guidelines, we would like to avoid jargon or unfamiliar acronyms in package names whenever possible. Since "NPA" is not even familiar to people in the field, I would ask to try to find a more descriptive package name.

Assuming that NPA is for the names of the method's originators, Navascués, Pironio, and Acín, this might be an opportunity to come up with something more descriptive name that captures the underlying idea.

[noblock]

@ewoodhead
Copy link

Hi, thanks for the feedback! I've added a descriptive paragraph to the beginning of the README. I hope this is sufficient for now. (I was planning on writing proper documentation and consequently modifying the README soon; my impression was that this would be a bit simpler once the package is already registered.)

Concerning the name, I'd already read the guidelines and I'd prefer to keep it as it is. The method and acronym (NPA) are already well known to people in the field who are likely to want to use it and I think using a more generic name like "QuantumOptimisation" or "QuantumCorrelations" would be counterproductive here.

@goerz
Copy link
Member

goerz commented Nov 29, 2024

[noblock] I don't really have a good specific suggestion for an alternative name at the moment, so I'll let that go. Maybe someone else will still have some good idea.

Please note that you have to add [noblock] to your comments, or they will block the registration

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
AutoMerge: last run blocked by comment PR blocked by one or more comments lacking the string [noblock]. new package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants