Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 1.63 KB

File metadata and controls

36 lines (23 loc) · 1.63 KB

Contributing to Cellestial

Thank you for your interest in Cellestial. Contributions are currently not accepted in the form of pull requests, but your input is genuinely valuable and there is a clear path to making an impact.

How to contribute

Open an issue. That is the single most helpful thing you can do.

Whether you found a bug, have a feature request, spotted unclear documentation, or want to suggest a new plot type, an issue starts the conversation. Good issues directly shape what gets built next.

What makes a good issue

Bug report

  • What you expected to happen
  • What actually happened
  • A minimal reproducible example (a few lines of code + the error message or unexpected output)
  • Your package versions (cl.versions() prints Cellestial, AnnData, Polars, and Python)

Feature request

  • What you are trying to visualize or accomplish
  • Why existing functionality does not cover it
  • A sketch or example of the desired API or output, if you have one

Documentation issue

  • Which page or function is unclear
  • What confused you and what you expected to find

Why not pull requests?

Cellestial has a deliberate design philosophy (see philosophy.md) and a tightly controlled API surface. Accepting code contributions requires significant review and integration effort that is not sustainable at this stage. Keeping contributions as issues ensures every change is intentional and consistent.

This may change in the future. Watch the repository for updates.

Questions

If you are unsure whether something is a bug or expected behavior, open an issue and ask. "How do I..." questions are welcome too.