Skip to content

docs(repo): meet CZI open source requirements - #461

Merged
mattersoflight merged 1 commit into
mainfrom
chore/open-source-readiness
Nov 6, 2026
Merged

mattersoflight merged 1 commit into
mainfrom
chore/open-source-readiness

Conversation

@srivarra

@srivarra srivarra commented Nov 5, 2026

Copy link
Copy Markdown
Collaborator

Related issue

N/A. Gets biahub ready for the move to the Biohub GitHub org, matching Biohub/waveorder#594, Biohub/VisCy#537 and Biohub/iohub#447.

Summary

biahub had no security policy or code of conduct. This PR adds SECURITY.md, the Contributor Covenant, a PR template, and a project status line. I called it alpha to match the Development Status :: 3 - Alpha classifier. LICENSE becomes LICENSE.md and credits Biohub.

The README and CONTRIBUTING changes sit inside the pymdownx.snippets regions, so the docs site picks them up too. Links in those regions stay absolute, like the rest.

uv.lock doesn't change. The repo has 0 open Dependabot alerts, and I ran all 357 locked PyPI packages through OSV with no hits.

Not done here:

  • The qc extra points at the private czbiohub-sf/imaging-qc-pipeline. It's already out of all, but outside users can't install it.
  • We can turn on secret scanning after the repo moves to the Biohub org.

Testing

  • uv lock --check passes.
  • The built wheel ships LICENSE.md as its license file (License-File: LICENSE.md).
  • pre-commit passes on the changed files.
  • I didn't run a docs build.

Checklist

  • I added or updated tests, or this change does not require tests.
  • I updated the documentation, or this change does not require documentation.
  • I confirmed this change does not include confidential or sensitive information.

Add SECURITY.md, the Contributor Covenant code of conduct, a pull request template, and a project status line. Rename LICENSE to LICENSE.md and credit Biohub.

Signed-off-by: Sricharan Reddy Varra <sricharan.varra@biohub.org>
@srivarra
srivarra marked this pull request as ready for review November 5, 2026 23:42
@srivarra
srivarra requested a review from ieivanov November 5, 2026 23:42
@mattersoflight
mattersoflight merged commit 50736b5 into main Nov 6, 2026
7 checks passed
tayllatheodoro added a commit that referenced this pull request Nov 9, 2026
Three commits: the virtual-stain timepoint statistics fix (#459), the CZI open
source files (#461), the actions bump (#460). No conflicts.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants