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: StochasticDominance v1.0.0 #124648

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

Conversation

JuliaRegistrator
Copy link
Contributor

@JuliaRegistrator JuliaRegistrator commented Feb 9, 2025

Copy link
Contributor

github-actions bot commented Feb 9, 2025

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.

@JuliaRegistrator JuliaRegistrator force-pushed the registrator-stochasticdominance-8041b248-v1.0.0-719146c114 branch from 84228cd to 810a73e Compare February 9, 2025 15:59
UUID: 8041b248-d9a2-49d2-9c7f-91ddf745d052
Repo: https://github.com/rajmadan96/StochasticDominance.jl.git
Tree: e8fdedb5f4f123294cac2fcf55ca0b4bef310ca8

Registrator tree SHA: 191228b6dd8b9d0e2965ae3e705fe54c51dcfee8
@JuliaRegistrator JuliaRegistrator force-pushed the registrator-stochasticdominance-8041b248-v1.0.0-719146c114 branch from 810a73e to 1dbeece Compare February 10, 2025 11:42
@goerz
Copy link
Member

goerz commented Feb 10, 2025

Thank you for submitting your package! Could you add a little bit of 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.

For a version 1.0, I definitely recommend setting up a Documenter-based documentation. You already seem to have documentation badges in your README, but these are currently broken. If you are following semantic versioning, a version 1.0 promises a stable API, which primarily means fully documented and tested. If you're not quite at that stage yet, I would recommend registering an initial version <1.0.

@JuliaTagBot JuliaTagBot added the AutoMerge: last run blocked by comment PR blocked by one or more comments lacking the string [noblock]. label Feb 10, 2025
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