Skip to content

Commit 6ba15b7

Browse files
LuisHeinzlmeierLuis
andauthored
Update dropdown chapter of CONTRIBUTING.md based on practical feedback (#360)
* improve dropdown paragraph based on Seo's feedback * add one sentence and improve wording * add changelog --------- Co-authored-by: Luis <ge34lah@mytum.de>
1 parent 76b904c commit 6ba15b7

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,11 @@ The first sentence of key takeaway 2.
157157
If you want to link a key takeaway to a certain heading in your chapter, add `<section-name>-<notebook-name>-key-takeaway-<key-takeaway-number>` as a label before the heading.
158158
Replace all `_` with `-`, and the card of the key takeaway will be linked to the heading in the text (e.g., `(preprocessing-visualization-dimensionality-reduction-key-takeaway-2)=`).
159159

160-
You can insert the dropdowns locally by calling `make dropdown` before `make`.
160+
Our CI workflow (`.github/worksflows/build_book.yml`) will call `make dropdown` when building the book.
161+
For testing, you can insert the dropdowns locally by calling `make dropdown` before `make`.
162+
163+
> [!WARNING]
164+
> Executing `make dropdown` locally will modify nearly all notebook files. These changes should never be committed or pushed to the repository. We recommend discarding these changes immediately after running the command using `git restore .`. Ensure you’ve staged your wanted changes (`git add`) beforehand.
161165
162166
## Data access
163167

changelog.d/360.added.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update dropdown chapter of `CONTRIBUTING.md` based on practical feedback ([#360](https://github.com/theislab/single-cell-best-practices/pull/360)) <sub>@LuisHeinzlmeier</sub>

0 commit comments

Comments
 (0)