You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-17Lines changed: 7 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ Cellucid is split by responsibility:
17
17
|---|---|---|
18
18
|`cellucid`| Web app (UI + state + WebGL rendering) | are fixing UI bugs, rendering/performance, figure export, sessions, or community annotation frontend |
19
19
|`cellucid-python`| Python package + CLI (`prepare`, `serve`, `show_anndata`, hooks) + Sphinx docs | are fixing Python/CLI bugs, data prep/export, server endpoints, Jupyter hooks, or docs on ReadTheDocs |
20
-
|`cellucid-r` (this repo) | R package for exporting data to the Cellucid viewer format | are changing the R exporter (`cellucid_prepare()`), adding R-side tests/docs, or preparing for Bioconductor|
20
+
|`cellucid-r` (this repo) | R package for exporting data to the Cellucid viewer format | are changing the R exporter (`cellucid_prepare()`), adding R-side tests/docs, or preparing for CRAN|
21
21
|`cellucid-annotation`| GitHub repo template for community annotation | are changing the repo schema/validation/workflows |
22
22
23
23
If you’re not sure where a bug belongs, open an issue in the repo you’re currently using and include:
@@ -48,7 +48,7 @@ If the bug is “the viewer looks wrong”, also include:
48
48
49
49
Docs live in:
50
50
-`cellucid-r/man/` (generated `.Rd` files)
51
-
-`cellucid-r/vignettes/` (BiocStyle vignette)
51
+
-`cellucid-r/vignettes/` (package vignette)
52
52
-`cellucid-r/README.md`
53
53
54
54
If you edit `.Rd` files directly, be aware they are usually generated from roxygen comments in `cellucid-r/R/`.
@@ -60,7 +60,7 @@ Fast workflow:
60
60
1) Set up your R dev environment (see “Development setup”)
61
61
2) Make a small, focused change
62
62
3) Add/adjust tests (`testthat`)
63
-
4) Run `devtools::check()` (and `BiocCheck::BiocCheck()` if relevant)
63
+
4) Run `devtools::check()`
64
64
5) Submit a PR with a clear “what/why/how to verify”
0 commit comments