Skip to content

Commit

Permalink
[pre-commit.ci] auto fixes from pre-commit.com hooks
Browse files Browse the repository at this point in the history
for more information, see https://pre-commit.ci
  • Loading branch information
pre-commit-ci[bot] committed Dec 16, 2024
1 parent 9da0a91 commit 8d19c3d
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ It **does not** imply endorsement or that an in-depth review has been performed.

Submit a pull-request adding a `meta.yaml` file for your package to the `packages` directory.

- Please refer to other entries for examples
- The full definition of available fields is available in [`schema.json`](schema.json)
- Please copy the checklist from below into the pull request description and answer all questions.
- Please refer to other entries for examples
- The full definition of available fields is available in [`schema.json`](schema.json)
- Please copy the checklist from below into the pull request description and answer all questions.

## What are the requirements for an ecosystem package?

Expand All @@ -37,25 +37,25 @@ Short description: XXX

How does the package use scverse data structures (please describe in a few sentences): XXX

- [ ] The code is publicly available under an [OSI-approved](https://opensource.org/licenses/alphabetical) license
- [ ] The package provides versioned releases
- [ ] The package can be installed from a standard registry (e.g. PyPI, conda-forge, bioconda)
- [ ] Automated tests cover essential functions of the package and a reasonable range of inputs and conditions [^1]
- [ ] Continuous integration (CI) automatically executes these tests on each push or pull request [^2]
- [ ] The package provides API documentation via a website or README[^3]
- [ ] The package uses scverse datastructures where appropriate (i.e. AnnData, MuData or SpatialData and their modality-specific extensions)
- [ ] I am an author or maintainer of the tool and agree on listing the package on the scverse website
- [ ] The code is publicly available under an [OSI-approved](https://opensource.org/licenses/alphabetical) license
- [ ] The package provides versioned releases
- [ ] The package can be installed from a standard registry (e.g. PyPI, conda-forge, bioconda)
- [ ] Automated tests cover essential functions of the package and a reasonable range of inputs and conditions [^1]
- [ ] Continuous integration (CI) automatically executes these tests on each push or pull request [^2]
- [ ] The package provides API documentation via a website or README[^3]
- [ ] The package uses scverse datastructures where appropriate (i.e. AnnData, MuData or SpatialData and their modality-specific extensions)
- [ ] I am an author or maintainer of the tool and agree on listing the package on the scverse website

### Recommended

- [ ] Please announce this package on scverse communication channels (zulip, discourse, twitter)
- [ ] Please tag the author(s) these announcements. Handles (e.g. `@scverse_team`) to include are:
- Twitter:
- Zulip:
- Discourse:
- Mastodon:
- [ ] The package provides tutorials (or "vignettes") that help getting users started quickly
- [ ] The package uses the [scverse cookiecutter template](https://github.com/scverse/cookiecutter-scverse).
- [ ] Please announce this package on scverse communication channels (zulip, discourse, twitter)
- [ ] Please tag the author(s) these announcements. Handles (e.g. `@scverse_team`) to include are:
- Twitter:
- Zulip:
- Discourse:
- Mastodon:
- [ ] The package provides tutorials (or "vignettes") that help getting users started quickly
- [ ] The package uses the [scverse cookiecutter template](https://github.com/scverse/cookiecutter-scverse).

[^1]: We recommend thtat tests cover at least all user facing (public) functions. Minimal tests ensure that the function does not fail on an example data set. Ideally, tests also ensure the correctness of the results, e.g. by comparing against a snapshot.

Expand Down

0 comments on commit 8d19c3d

Please sign in to comment.