New package: HapSim v0.1.0

[JuliaRegistrator]

• Registering package: HapSim
• Repository: https://github.com/lescailab/HapSim.jl
• Created by: @sa-yo-nara
• Version: v0.1.0
• Commit: 88deff37b5e51eb8aaaeb3ce9d43e954803f7905
• Git reference: HEAD

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

[goerz]

There seems to be a mismatch between the package and the README, which appears to describe something called HAPNEST. I do not see any documentation for a Julia package HapSim.

At the very least, the README should include a description of the Julia 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 v1.0 release, or for smaller packages that can be effectively described entirely with their README, that's not a requirement, though.

[sa-yo-nara]

Hi @goerz
I've updated the README file as requested. I added references, prerequisites, and a short tutorial with the main commands.
I hope everything looks good now.

Please let me know if there's anything else you'd like me to adjust.

Best regards,
Said

[sa-yo-nara]

Hi @goerz

I hope you're doing well. I was wondering if there are any updates regarding the package?

[goerz]

It's up to you to fix the automerge isues...?

[sa-yo-nara]

Hi, The error occurred because I was using Pkg operations in my package code via include rather than import, but hadn’t explicitly declared Pkg as a dependency in the Project.toml.
I’ve now added Pkg to the [deps] section of the Project.toml:

[goerz]

Pkg should (almost) never be a dependency of any package. That's a sign that something is pretty fundamentally wrong. Looking at the repo, the code organization seems to be a mess, so this is probably not anywhere near ready to be released as a Julia package. I would recommend that you follow the standard best practices: You should only have include statements in the top src/HapSim.jl file. You src folder should only contain the files listed there, and you should not have include statements in any other file (a.k.a., every file must be included only once). Do not use include in your test/run_tests.jl file to load your package. That should only happen via using HapSim. Please also make sure that you run your test suite in GitHub Actions

[sa-yo-nara]

Hi @goerz ,

Thank you for your detailed recommendations — I really appreciate the feedback. I've now worked on a new version of the package, taking your suggestions into account. I've reorganized the code structure to follow standard best practices: the src/HapSim.jl file now contains all the include statements, and each source file is included only once. I've also removed any unnecessary dependencies like Pkg, and ensured that the test suite loads the package using using HapSim

[goerz]

Make sure to set up GitHub actions to run your test suite automatically

[sa-yo-nara]

Hi, I can now see the desired output, but I am confused about the automerge error that appears. The error message says:

RegistryCI.AutoMerge.AutoMergeGuidelinesNotMet("The automerge guidelines were not met.")

It seems that the automerge process failed because some guidelines or conditions required for automatically merging the pull request were not satisfied. However, I don’t fully understand which specific guideline was not met or why this is happening.

[goerz]

Do you not see the section 2 in #130947 (comment)?

2. AutoMerge Guidelines which are not met ❌

• There is no compat entry for julia.

• The following dependencies do not have a [compat] entry that is upper-bounded and only includes a finite number of breaking releases: CSV, CategoricalArrays, Conda, DataFrames, Distances, Distributions, GpABC, Impute, LsqFit, MendelPlots, Plots, ProgressMeter, PyCall, StatsBase, StatsPlots, YAML

  Extended explanation:

  Your package has a Project.toml file which might look something like the following:

  name = "YourPackage"
  uuid = "random id"
  authors = ["Author Names"]
  version = "major.minor"
  
  [deps]
  # Package dependencies
  # ...
  
  [compat]
  # ...

  Every package listed in [deps], along with julia itself, must also be listed under [compat] (if you don't have a [compat] section, make one!). See the Pkg docs for the syntax for compatibility bounds, and this documentation for more on the kinds of compat bounds required for AutoMerge.

[sa-yo-nara]

thanks, i update the project.toml and now all automerge checks are ok