Skip to content

Commit 554f3bc

Browse files
Ramdam17github-actions[bot]
authored andcommitted
Update project data for Issue #5
1 parent c2f37c3 commit 554f3bc

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

data/projects/project_5.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"Title": "<p>HyPyP Cookbook Sprint: a community-driven onboarding kit (docs, tutorials, examples, and small feature fixes)</p>\n",
3-
"Leaders": "<ul>\n<li>Rémy Ramadour // remy.ramadour.hsj@ssss.gouv.qc.ca // Discord: @ramdam79</li>\n<li>Patrice Fortin (waiting list)</li>\n</ul>\n",
4-
"Collaborators": "<ul>\n<li>Vincent Chamberland</li>\n<li>Nadine Mohamed</li>\n<li>Mariem Hafsia</li>\n<li>Saskia Helbling (waiting list)</li>\n<li>Anne Monnier (waiting list)</li>\n<li>Anaïs Rourre (waiting list)</li>\n</ul>\n",
3+
"Leaders": "<ul>\n<li>Rémy Ramadour // remy.ramadour.hsj@ssss.gouv.qc.ca // Discord: @ramdam79</li>\n<li>Patrice Fortin // patrice.fortin.hsj@ssss.gouv.qc.ca // Discord: @osokin</li>\n</ul>\n",
4+
"Collaborators": "<ul>\n<li>Vincent Chamberland</li>\n<li>Nadine Mohamed</li>\n<li>Mariem Hafsia</li>\n<li>Saskia Helbling</li>\n<li>Anne Monnier</li>\n<li>Anaïs Rourre</li>\n</ul>\n",
55
"Project Description": "<p>HyPyP is an open-source Python toolbox for hyperscanning and interpersonal brain/physiology synchrony analyses. The goal of this BrainHack project is to build a community-driven onboarding kit that makes HyPyP easier to learn, run, and extend—especially for newcomers.</p>\n<p>Concretely, we will produce a Cookbook: a small set of well-documented, reproducible tutorials (notebooks), improved documentation, and contributor-friendly entry points (“good first issues”). This will help students, researchers, and engineers quickly go from “I installed HyPyP” to “I can run a complete synchrony workflow and understand what I’m doing,” while also making it easier for new contributors to participate.</p>\n<p>As part of the Cookbook effort, we will also identify the main bottlenecks and roadblocks that create friction for newcomers (installation issues, unclear steps, common pitfalls) and either remove them when feasible or document clear solutions (troubleshooting/FAQ).</p>\n<p>This is a high-impact, low-friction community effort: in only a few days, we can significantly reduce the barrier to entry for hyperscanning analyses and improve reproducibility. The project is designed to be inclusive: contributors can help through writing, reviewing, coding, testing, visualization, or pedagogy, at beginner/intermediate/advanced levels.</p>\n<p>Bonus: if time allows, we’ll implement a small “quality-of-life” improvement (e.g., clearer API wrapper, tests, example dataset, or minor feature fix) so the event yields both documentation and code improvements.</p>\n<p>Participants will:</p>\n<ul>\n<li>clone the repo, install dependencies, and run a “hello world” notebook,</li>\n<li>pick a task (tutorial writing, doc improvement, tests/CI, visualization, small feature),</li>\n<li>submit contributions via PRs using templates and “good first issues” labels.</li>\n</ul>\n<p>We will provide a clear README, a beginner-friendly checklist, and a live coordination channel during the event.</p>\n",
66
"Link to project repository/sources": "<p><a href=\"https://github.com/ppsp-team/HyPyPCookbook\">https://github.com/ppsp-team/HyPyPCookbook </a></p>\n",
77
"Goals for Brainhack Montreal": "<p><strong>Milestone 1 — “Onboarding Kit” baseline (Day 1)</strong></p>\n<p><strong><em>Deliverables</em></strong></p>\n<ul>\n<li>A refreshed Quickstart in README: install, minimal example, expected output.</li>\n<li>A Cookbook skeleton: folder structure + table of contents.</li>\n<li>At least 5 “good first issues” ready to pick.</li>\n<li>A first pass “Friction log” (list of newcomer bottlenecks/roadblocks + proposed fixes or documentation links).</li>\n</ul>\n<p><strong><em>Beginner-friendly tasks</em></strong></p>\n<ul>\n<li>Rewrite/install troubleshooting (macOS/Windows/Linux, conda/poetry/pip).</li>\n<li>Add a glossary page: key concepts + links.</li>\n<li>Report friction points while onboarding (what broke / what was unclear) and propose wording fixes.</li>\n</ul>\n<p><strong><em>Intermediate tasks</em></strong></p>\n<ul>\n<li>Add a minimal simulated dataset and a script/notebook that runs end-to-end.</li>\n<li>Add CI smoke test: “import + run minimal pipeline”.</li>\n</ul>\n<p><strong>Milestone 2 — Tutorials that run end-to-end (Day 2)</strong></p>\n<p><strong><em>Deliverables</em></strong></p>\n<ul>\n<li>2–3 runnable notebooks with expected outputs saved (figures/tables):</li>\n<li>Hello synchrony (simulated signals → compute synchrony metrics)</li>\n<li>EEG hyperscanning minimal (MNE preprocessing → HyPyP metrics)</li>\n<li>Stats &amp; surrogates (permutation/surrogate testing + interpretation)</li>\n<li>Optional: a short notebook section or mini-notebook for common group stats (t-test / ANOVA) on synchrony outputs.</li>\n</ul>\n<p><strong><em>Beginner tasks</em></strong></p>\n<ul>\n<li>Improve narrative: explanations, figures, “what to check if results look wrong”.</li>\n<li>Add docstrings / examples to 2–3 public functions.</li>\n</ul>\n<p><strong><em>Intermediate tasks</em></strong></p>\n<ul>\n<li>Add unit tests for one tutorial pipeline (golden outputs / shape checks).</li>\n<li>Add a “common pitfalls” page (filtering, alignment, edge effects, leakage).</li>\n<li>Turn top friction items into fixes or documented solutions (FAQ / troubleshooting entries).</li>\n</ul>\n<p><strong><em>Advanced tasks</em></strong></p>\n<ul>\n<li>Identify and fix one small “paper cut” in the API (naming, defaults, error messages).</li>\n<li>Optional: add a small feature/wrapper improving usability, with tests + docs.</li>\n</ul>\n<p><strong>Milestone 3 — Integration &amp; demo-ready output (Day 3)</strong></p>\n<p><strong><em>Deliverables</em></strong></p>\n<ul>\n<li>A single BrainHack Demo Notebook that runs in &lt;10 minutes.</li>\n<li>A short “How to contribute” page + contributor credit instructions.</li>\n<li>A short report: what was improved, what remains, next steps.</li>\n<li>A consolidated “Friction log” summary (top bottlenecks + resolutions / workarounds).</li>\n</ul>\n<p><strong><em>Quality bar</em></strong></p>\n<ul>\n<li>Everything runs from a clean environment (fresh install) using the Quickstart.</li>\n<li>PRs merged, issues triaged, next milestones listed for after the event.</li>\n</ul>\n",

0 commit comments

Comments
 (0)