-
Notifications
You must be signed in to change notification settings - Fork 473
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: CompChem v1.0.0 #120381
base: master
Are you sure you want to change the base?
New package: CompChem v1.0.0 #120381
Conversation
JuliaRegistrator
commented
Nov 29, 2024
- Registering package: CompChem
- Repository: https://github.com/vishnu2709/CompChem.jl
- Created by: @vishnu2709
- Version: v1.0.0
- Commit: 72c994e1227619c2cfb1fb924dc17f4096d69ecf
- Reviewed by: @vishnu2709
- Reference: Register package vishnu2709/QuantumPhoenix.jl#2
- Description: Software package for computational chemistry calculations
UUID: e4d0f6e5-aaef-4631-895e-149e7b48cbc0 Repo: https://github.com/vishnu2709/CompChem.jl.git Tree: f33a615fa9905f96899dcc3198391af2cf849ec0 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! However, I would be concerned that the package name is far too general, at least given the current state of the project. In any case, this would need a bit more 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. In the longer term, I definitely recommend setting up a Documenter-based documentation. Before a But getting back to the scope of the package: "Computational Chemistry" is a very large field, and a package that encompasses the entire field is probably not manageable by a single person. I'm not saying there couldn't be a registered package The alternative would be to find a more descriptive package name, for a narrower scope. |
@goerz Thank you for taking the time to give me detailed feedback, it is very appreciated. I will add more features and documentation to the package (and hopeful find some collaborators) and submit the package later when it is more useful to the community. |