Blampey Quentin
commited on
Commit
·
f606aed
1
Parent(s):
c0fd0fc
minor contributing.md update
Browse files- CONTRIBUTING.md +5 -5
CONTRIBUTING.md
CHANGED
|
@@ -2,12 +2,12 @@
|
|
| 2 |
|
| 3 |
For now, only users with permissions for this repository can add/delete datasets. If you don't have the permissions but want to add a dataset, open an issue to discuss with us.
|
| 4 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 5 |
## Adding a dataset
|
| 6 |
|
| 7 |
1. Add one/multiple `.h5ad` file(s) under the right directory, according to the right `species` and `tissue`. E.g., `human/breast/filename.h5ad`. Each file corresponds to one slide.
|
| 8 |
2. Fill the corresponding metadata under `metadata.csv`
|
| 9 |
-
3.
|
| 10 |
-
|
| 11 |
-
```sh
|
| 12 |
-
|
| 13 |
-
```
|
|
|
|
| 2 |
|
| 3 |
For now, only users with permissions for this repository can add/delete datasets. If you don't have the permissions but want to add a dataset, open an issue to discuss with us.
|
| 4 |
|
| 5 |
+
## Git-LFS setup
|
| 6 |
+
|
| 7 |
+
Before adding a dataset, make sure you have setup [`git-lfs`](https://git-lfs.com/).
|
| 8 |
+
|
| 9 |
## Adding a dataset
|
| 10 |
|
| 11 |
1. Add one/multiple `.h5ad` file(s) under the right directory, according to the right `species` and `tissue`. E.g., `human/breast/filename.h5ad`. Each file corresponds to one slide.
|
| 12 |
2. Fill the corresponding metadata under `metadata.csv`
|
| 13 |
+
3. Just commit files as usual. `git-lfs` will handle it.
|
|
|
|
|
|
|
|
|
|
|
|