-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathCONTRIBUTING.html
More file actions
1167 lines (922 loc) · 56.1 KB
/
CONTRIBUTING.html
File metadata and controls
1167 lines (922 loc) · 56.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta property="og:title" content="Contributing guide" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://skrub-data.github.io/stable/CONTRIBUTING.html" />
<meta property="og:site_name" content="skrub" />
<meta property="og:description" content="First off, thank you for taking the time to contribute! Below are some guidelines to help you get started. Have a question?: If you have any questions, feel free to reach out: Join our community on..." />
<meta property="og:image" content="https://skrub-data.github.io/stable/_static/skrub.svg" />
<meta property="og:image:alt" content="skrub" />
<meta name="description" content="First off, thank you for taking the time to contribute! Below are some guidelines to help you get started. Have a question?: If you have any questions, feel free to reach out: Join our community on..." />
<title>Contributing guide — skrub</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Vibur" />
<link rel="stylesheet" type="text/css" href="_static/jupyterlite_sphinx.css?v=8ee2c72c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=7821ceae" />
<!-- So that users can add custom icons -->
<script src="_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
<script src="_static/documentation_options.js?v=486e5634"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=fd10adb8"></script>
<script src="_static/jupyterlite_sphinx.js?v=96e329c5"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'CONTRIBUTING';</script>
<script>
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://raw.githubusercontent.com/skrub-data/skrub/main/doc/version.json';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '0.8.0';
DOCUMENTATION_OPTIONS.show_version_warning_banner =
true;
</script>
<script src="_static/scripts/sg_plotly_resize.js?v=a751aa24"></script>
<link rel="canonical" href="https://skrub-data.org/stable/CONTRIBUTING.html" />
<link rel="icon" href="_static/skrub.svg"/>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="How to write an example for the gallery" href="tutorial_example.html" />
<link rel="prev" title="About" href="about.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.8.0" />
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class=" navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="index.html">
<img src="_static/skrub.svg" class="logo__image only-light" alt="skrub - Home"/>
<img src="_static/skrub.svg" class="logo__image only-dark pst-js-only" alt="skrub - Home"/>
</a></div>
</div>
<div class=" navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="install.html">
Install
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="documentation.html">
User Guide
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="reference/index.html">
API Reference
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="auto_examples/index.html">
Examples
</a>
</li>
<li class="nav-item dropdown">
<button class="btn dropdown-toggle nav-item" type="button"
data-bs-toggle="dropdown" aria-expanded="false"
aria-controls="pst-nav-more-links">
More
</button>
<ul id="pst-nav-more-links" class="dropdown-menu">
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="learning_materials.html">
Learning Materials
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="CHANGES.html">
Release history
</a>
</li>
<li class=" current active">
<a class="nav-link dropdown-item nav-internal" href="development.html">
Development
</a>
</li>
</ul>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<div class="navbar-item">
<div class="version-switcher__container dropdown pst-js-only">
<button id="pst-version-switcher-button-2"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-2"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-2"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-2">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div></div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/skrub-data/skrub/" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a href="https://discord.gg/ABaPnm7fDC" title="Discord" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-discord fa-lg" aria-hidden="true"></i>
<span class="sr-only">Discord</span></a>
</li>
<li class="nav-item">
<a href="https://bsky.app/profile/skrub-data.bsky.social" title="Bluesky" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-bluesky fa-lg" aria-hidden="true"></i>
<span class="sr-only">Bluesky</span></a>
</li>
<li class="nav-item">
<a href="https://x.com/skrub_data" title="X (ex-Twitter)" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-x-twitter fa-lg" aria-hidden="true"></i>
<span class="sr-only">X (ex-Twitter)</span></a>
</li>
</ul></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="install.html">
Install
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="documentation.html">
User Guide
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="reference/index.html">
API Reference
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="auto_examples/index.html">
Examples
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="learning_materials.html">
Learning Materials
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="CHANGES.html">
Release history
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="development.html">
Development
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<div class="version-switcher__container dropdown pst-js-only">
<button id="pst-version-switcher-button-3"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-3"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-3"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-3">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div></div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/skrub-data/skrub/" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a href="https://discord.gg/ABaPnm7fDC" title="Discord" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-discord fa-lg" aria-hidden="true"></i>
<span class="sr-only">Discord</span></a>
</li>
<li class="nav-item">
<a href="https://bsky.app/profile/skrub-data.bsky.social" title="Bluesky" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-bluesky fa-lg" aria-hidden="true"></i>
<span class="sr-only">Bluesky</span></a>
</li>
<li class="nav-item">
<a href="https://x.com/skrub_data" title="X (ex-Twitter)" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-x-twitter fa-lg" aria-hidden="true"></i>
<span class="sr-only">X (ex-Twitter)</span></a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="vision.html">Vision: Where is skrub heading?</a></li>
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Contributing guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial_example.html">How to write an example for the gallery</a></li>
<li class="toctree-l1"><a class="reference internal" href="RELEASE_PROCESS.html">Release process</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item"><a href="development.html" class="nav-link">Development</a></li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">Contributing guide</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="contributing-guide">
<span id="contributing"></span><h1>Contributing guide<a class="headerlink" href="#contributing-guide" title="Link to this heading">#</a></h1>
<p>First off, thank you for taking the time to contribute!</p>
<p>Below are some guidelines to help you get started.</p>
<section id="have-a-question">
<h2>Have a question?<a class="headerlink" href="#have-a-question" title="Link to this heading">#</a></h2>
<p>If you have any questions, feel free to reach out:</p>
<ul class="simple">
<li><p>Join our community on <a class="reference external" href="https://discord.gg/ABaPnm7fDC">Discord</a> for general chat and Q&A.</p></li>
<li><p>Alternatively, you can <a class="reference external" href="https://github.com/skrub-data/skrub/discussions">start a discussion on GitHub</a>.</p></li>
</ul>
</section>
<section id="what-to-know-before-you-begin">
<h2>What to know before you begin<a class="headerlink" href="#what-to-know-before-you-begin" title="Link to this heading">#</a></h2>
<p>To understand the purpose and goals behind skrub, please read our
<a class="reference external" href="https://skrub-data.org/stable/vision.html">vision statement</a>.</p>
<p>If you’re interested in the research behind skrub,
we encourage you to explore these papers:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://hal.inria.fr/hal-01806175">Similarity Encoding for Learning with Dirty
Categorical Variables</a></p></li>
<li><p><a class="reference external" href="https://hal.inria.fr/hal-02171256v4">Encoding High-Cardinality String Categorical
Variables</a>.</p></li>
</ul>
</section>
<section id="how-can-i-contribute">
<h2>How can I contribute?<a class="headerlink" href="#how-can-i-contribute" title="Link to this heading">#</a></h2>
<section id="reporting-bugs">
<h3>Reporting bugs<a class="headerlink" href="#reporting-bugs" title="Link to this heading">#</a></h3>
<p>Using the library is the best way to discover bugs and limitations. If you find one,
please:</p>
<ol class="arabic simple">
<li><p><strong>Check if an issue already exists</strong>
by searching the <a class="reference external" href="https://github.com/skrub-data/skrub/issues?q=is%3Aissue">GitHub issues</a></p>
<ul class="simple">
<li><p>If <strong>open</strong>, leave a 👍 on the original message to signal that you are also affected.</p></li>
<li><dl class="simple">
<dt>If closed, check for one of the following:</dt><dd><ul>
<li><p>A <strong>merged pull request</strong> may indicate the bug is fixed. Update your
skrub version or note if the fix is pending a release.</p></li>
<li><p>A <strong>wontfix label</strong> or reasoning may be provided if the issue was
closed without a fix.</p></li>
</ul>
</dd>
</dl>
</li>
</ul>
</li>
<li><p>If the issue does not exist, <a class="reference external" href="https://github.com/skrub-data/skrub/issues/new">create a new one</a>.</p></li>
</ol>
<section id="how-to-submit-a-bug-report">
<h4>How to submit a bug report?<a class="headerlink" href="#how-to-submit-a-bug-report" title="Link to this heading">#</a></h4>
<p>To help us resolve the issue quickly, please include:</p>
<ul class="simple">
<li><p>A <strong>clear and descriptive title</strong>.</p></li>
<li><p>A <strong>summary of the expected result</strong>.</p></li>
<li><p>Any <strong>additional details</strong> where the bug might occur or doesn’t occur unexpectedly.</p></li>
<li><p>A <strong>code snippet</strong> that reproduces the issue, if applicable.</p></li>
<li><p><strong>Version information</strong> for Python, skrub, and relevant dependencies (e.g., scikit-learn, numpy, pandas).</p></li>
</ul>
</section>
<section id="how-to-write-an-example">
<h4>How to write an example?<a class="headerlink" href="#how-to-write-an-example" title="Link to this heading">#</a></h4>
<p>We highly encourage contributors to add examples to the documentation
when they add new features, or if they have a use case that is not yet covered
in the documentation.</p>
<p>You can find a guide on how to write examples in the <a class="reference internal" href="tutorial_example.html#tutorial-write-example"><span class="std std-ref">example guide</span></a>.</p>
</section>
</section>
<section id="suggesting-enhancements">
<h3>Suggesting enhancements<a class="headerlink" href="#suggesting-enhancements" title="Link to this heading">#</a></h3>
<p>If you have an idea for improving skrub, whether it’s a fix
or a new feature, first:</p>
<ul class="simple">
<li><p><strong>Check if it has been proposed or implemented</strong> by reviewing
<a class="reference external" href="https://github.com/skrub-data/skrub/pulls?q=is%3Apr">open pull requests</a>.</p></li>
<li><p>If not, <a class="reference external" href="https://github.com/skrub-data/skrub/issues/new">submit a new issue</a>
with your proposal before writing any code.</p></li>
</ul>
<section id="how-to-submit-an-enhancement-proposal">
<h4>How to submit an enhancement proposal?<a class="headerlink" href="#how-to-submit-an-enhancement-proposal" title="Link to this heading">#</a></h4>
<p>When proposing an enhancement:</p>
<ul class="simple">
<li><p><strong>Use a clear and descriptive title</strong>.</p></li>
<li><p><strong>Explain the goal</strong> of the enhancement.</p></li>
<li><p>Provide a <strong>detailed step-by-step description</strong> of the proposed change.</p></li>
<li><p><strong>Link to any relevant resources</strong> that may support the enhancement.</p></li>
</ul>
<section id="if-the-enhancement-proposal-is-validated">
<h5>If the enhancement proposal is validated<a class="headerlink" href="#if-the-enhancement-proposal-is-validated" title="Link to this heading">#</a></h5>
<p>Once your enhancement proposal is approved, let the maintainers know the following:</p>
<ul class="simple">
<li><p><strong>If you will write the code and submit a Pull Request (PR)</strong>:
Contributing the feature yourself is the quickest way to see it implemented.
We’re here to guide you through the process if needed! To get started,
refer to the section <a class="reference internal" href="#writing-your-first-pull-request"><span class="std std-ref">Writing your first Pull Request</span></a>.</p></li>
<li><p><strong>If you won’t be writing the code</strong>:
A developer can then take over the implementation.
However, please note that we cannot guarantee how long
it will take for the feature to be added.</p></li>
</ul>
</section>
<section id="if-the-enhancement-is-refused">
<h5>If the enhancement is refused<a class="headerlink" href="#if-the-enhancement-is-refused" title="Link to this heading">#</a></h5>
<p>Although many ideas are great, not all will align with the objectives
of skrub.</p>
<p>If your enhancement is not accepted, consider implementing it
as a separate package that builds on top of skrub!</p>
<p>We would love to see your work, and in some cases, we might even
feature your package in the official repository.</p>
</section>
</section>
</section>
<section id="writing-your-first-pull-request">
<span id="id1"></span><h3>Writing your first Pull Request<a class="headerlink" href="#writing-your-first-pull-request" title="Link to this heading">#</a></h3>
<section id="preparing-the-ground">
<h4>Preparing the ground<a class="headerlink" href="#preparing-the-ground" title="Link to this heading">#</a></h4>
<p>Before writing any code, make sure you have discussed your plans with the maintainers.
You can do this by opening a new issue to discuss a specific improvement (as
described above), or by commenting on an existing issue to express your interest in working on it.</p>
<p>Be sure to get approval from the maintainers before you start coding, and especially
before opening any new pull requests (PRs). This helps prevent issues such as multiple
people working on the same problem independently, or working on an issue that is
not clearly defined. Without prior discussion, your PR may be closed for being out
of scope or unrelated to the problem at hand.</p>
<p>Every PR should link to the issue it addresses.</p>
</section>
<section id="setting-up-the-environment">
<h4>Setting up the environment<a class="headerlink" href="#setting-up-the-environment" title="Link to this heading">#</a></h4>
<p>To setup your development environment, you need to follow the steps in “From Source” tab
present in <a class="reference internal" href="install.html#installing-from-source"><span class="std std-ref">Installing from source</span></a> page.
After that, you can return to this page to continue.</p>
<p>Now that the development environment is ready, you may create a new branch and start working on
the new issue.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># fetch latest updates and start from the current head</span>
git<span class="w"> </span>fetch<span class="w"> </span>upstream
git<span class="w"> </span>checkout<span class="w"> </span>-b<span class="w"> </span>my-branch-name-eg-fix-issue-123
<span class="c1"># make some changes</span>
git<span class="w"> </span>add<span class="w"> </span>./the/file-i-changed
git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">"my message"</span>
git<span class="w"> </span>push<span class="w"> </span>--set-upstream<span class="w"> </span>origin<span class="w"> </span>my-branch-name-eg-fix-issue-123
</pre></div>
</div>
<p>At this point, if you visit again the <a class="reference external" href="https://github.com/skrub-data/skrub/pulls">pull requests
page</a> github should show a
banner asking if you want to open a pull request from your new branch.</p>
</section>
<section id="implementation-guidelines">
<span id="id2"></span><h4>Implementation Guidelines<a class="headerlink" href="#implementation-guidelines" title="Link to this heading">#</a></h4>
<p>When contributing, keep these project goals in mind:</p>
<ul class="simple">
<li><p><strong>Pure Python code</strong>: Avoid using binary extensions, Cython, or other compiled languages.</p></li>
<li><dl class="simple">
<dt><strong>Production-friendly code</strong>:</dt><dd><ul>
<li><p>Target the widest possible range of Python versions and dependencies.</p></li>
<li><p>Minimize the use of external dependencies.</p></li>
<li><p>Ensure backward compatibility as much as possible.</p></li>
</ul>
</dd>
</dl>
</li>
<li><p><strong>Performance over readability</strong>:
Optimized code may be less readable, so please include clear and detailed comments.
Refer to this <a class="reference external" href="https://stackoverflow.blog/2021/12/23/best-practices-for-writing-code-comments/">best practice guide</a>.</p></li>
<li><p><strong>Explicit variable/function names</strong>: Use descriptive, verbose names for clarity.</p></li>
<li><dl class="simple">
<dt><strong>Document public API components</strong>:</dt><dd><ul>
<li><p>Document all public functions, methods, variables, and class signatures.</p></li>
<li><p>The public API refers to all components available for import and use by library users. Anything that doesn’t begin with an underscore is considered part of the public API.</p></li>
</ul>
</dd>
</dl>
</li>
</ul>
</section>
</section>
</section>
<section id="checking-the-quality-of-your-code-contribution">
<h2>Checking the quality of your code contribution<a class="headerlink" href="#checking-the-quality-of-your-code-contribution" title="Link to this heading">#</a></h2>
<section id="testing-the-code">
<h3>Testing the code<a class="headerlink" href="#testing-the-code" title="Link to this heading">#</a></h3>
<p>Tests for files in a given folder should be located in a sub-folder
named <code class="docutils literal notranslate"><span class="pre">tests</span></code>: tests for Skrub objects are located in <code class="docutils literal notranslate"><span class="pre">skrub/tests/</span></code>,
tests for the dataframe API are in <code class="docutils literal notranslate"><span class="pre">skrub/_dataframe/tests/</span></code> and so on.</p>
<p>Tests should check all functionalities of the code that you are going to
add. If needed, additional tests should be added to verify that other
objects behave correctly.</p>
<p>Consider an example: your contribution is for the
<code class="docutils literal notranslate"><span class="pre">AmazingTransformer</span></code>, whose code is in
<code class="docutils literal notranslate"><span class="pre">skrub/_amazing_transformer.py</span></code>. The <code class="docutils literal notranslate"><span class="pre">AmazingTransformer</span></code> is added
as one of the default transformers for <code class="docutils literal notranslate"><span class="pre">TableVectorizer</span></code>.</p>
<p>As such, you should add a new file testing the functionality of
<code class="docutils literal notranslate"><span class="pre">AmazingTransformer</span></code> in <code class="docutils literal notranslate"><span class="pre">skrub/tests/test_amazing_transformer.py</span></code>,
and update the file <code class="docutils literal notranslate"><span class="pre">skrub/tests/test_table_vectorizer.py</span></code> so that it
takes into account the new transformer.</p>
<p>Additionally, you might have updated the internal dataframe API in
<code class="docutils literal notranslate"><span class="pre">skrub/_dataframe/_common.py</span></code> with a new function,
<code class="docutils literal notranslate"><span class="pre">amazing_function</span></code>. In this case, you should also update
<code class="docutils literal notranslate"><span class="pre">skrub/_dataframe/tests/test_common.py</span></code> to add a test for the
<code class="docutils literal notranslate"><span class="pre">amazing_function</span></code>.</p>
<p>Run each updated test file using <code class="docutils literal notranslate"><span class="pre">pytest</span></code>
(<a class="reference external" href="https://docs.pytest.org/en/stable">pytest docs</a>):</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pytest<span class="w"> </span>-vsl<span class="w"> </span>skrub/tests/test_amazing_transformer.py<span class="w"> </span><span class="se">\</span>
skrub/_dataframe/tests/test_common.py<span class="w"> </span><span class="se">\</span>
skrub/_dataframe/tests/test_table_vectorizer.py
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">-vsl</span></code> flag provides more information when running the tests.</p>
<p>It is also possible to run a specific test, or set of tests using the
commands <code class="docutils literal notranslate"><span class="pre">pytest</span> <span class="pre">the_file.py::the_test</span></code>, or
<code class="docutils literal notranslate"><span class="pre">pytest</span> <span class="pre">the_file.py</span> <span class="pre">-k</span> <span class="pre">'test_name_pattern'</span></code>. This is helpful to avoid
having to run all the tests.</p>
<p>If you work on Windows, you might have some issues with the working
directory if you use <code class="docutils literal notranslate"><span class="pre">pytest</span></code>, while <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">pytest</span> <span class="pre">...</span></code> should
be more robust.</p>
<p>Once you are satisfied with your changes, you can run all the tests to make sure
that your change did not break code elsewhere:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pytest<span class="w"> </span>-s<span class="w"> </span>skrub/tests
</pre></div>
</div>
<p>Finally, sync your changes with the remote repository and wait for CI to run.</p>
</section>
<section id="checking-coverage-on-the-local-machine">
<h3>Checking coverage on the local machine<a class="headerlink" href="#checking-coverage-on-the-local-machine" title="Link to this heading">#</a></h3>
<p>Checking coverage is one of the operations that is performed after
submitting the code. As this operation may take a long time online, it
is possible to check whether the code coverage is high enough on your
local machine.</p>
<p>Run your tests with the <code class="docutils literal notranslate"><span class="pre">--cov</span></code> and <code class="docutils literal notranslate"><span class="pre">--cov-report</span></code> arguments:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pytest<span class="w"> </span>-vsl<span class="w"> </span>skrub/tests/test_amazing_transformer.py<span class="w"> </span>--cov<span class="o">=</span>skrub<span class="w"> </span>--cov-report<span class="o">=</span>html
</pre></div>
</div>
<p>This will create the folder <code class="docutils literal notranslate"><span class="pre">htmlcov</span></code>: by opening
<code class="docutils literal notranslate"><span class="pre">htmlcov/index.html</span></code> it is possible to check what lines are covered in
each file.</p>
</section>
<section id="updating-doctests">
<h3>Updating doctests<a class="headerlink" href="#updating-doctests" title="Link to this heading">#</a></h3>
<p>If you alter the default behavior of an object, then this might affect
the docstrings. Check for possible problems by running</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pytest<span class="w"> </span>skrub/path/to/file
</pre></div>
</div>
</section>
<section id="formatting-and-pre-commit-checks">
<h3>Formatting and pre-commit checks<a class="headerlink" href="#formatting-and-pre-commit-checks" title="Link to this heading">#</a></h3>
<p>Formatting the code well helps with code development and maintenance,
which why is skrub requires that all commits follow a specific set of
formatting rules to ensure code quality.</p>
<p>Luckily, these checks are performed automatically by the <code class="docutils literal notranslate"><span class="pre">pre-commit</span></code>
tool (<a class="reference external" href="https://pre-commit.com">pre-commit docs</a>) before any commit
can be pushed. Something worth noting is that if the <code class="docutils literal notranslate"><span class="pre">pre-commit</span></code>
hooks format some files, the commit will be canceled: you will have to
stage the changes made by <code class="docutils literal notranslate"><span class="pre">pre-commit</span></code> and commit again.</p>
</section>
<section id="ensuring-the-documentation-builds">
<h3>Ensuring the documentation builds<a class="headerlink" href="#ensuring-the-documentation-builds" title="Link to this heading">#</a></h3>
<p>First, make sure you have properly installed the development version of skrub.
You can follow the <a class="reference internal" href="install.html#installation-instructions"><span class="std std-ref">Install</span></a> > “From source” section, if needed.</p>
<p>To build the documentation, you need to be in the <code class="docutils literal notranslate"><span class="pre">doc</span></code> folder:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>doc
</pre></div>
</div>
<p>To generate the full documentation, including the example gallery,
run the following command:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make<span class="w"> </span>html
</pre></div>
</div>
<p>On Windows, use:</p>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>make.bat html
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If you are working on Windows, building the example <code class="docutils literal notranslate"><span class="pre">1131_optuna_choices</span></code>
may fail with a permission error when running <code class="docutils literal notranslate"><span class="pre">make.bat</span> <span class="pre">html</span></code>. This is
because optuna uses symlinks for file locking, which requires admin
privileges on Windows by default. The rest of the documentation build
should run without problem, so it is safe to ignore this error if your
contribution does not touch that particular example.</p>
</div>
<p>The documentation will be generated in the <code class="docutils literal notranslate"><span class="pre">_build/html/</span></code> directory
and are viewable in a web browser, for instance by opening the local
<code class="docutils literal notranslate"><span class="pre">_build/html/index.html</span></code> file.</p>
<p>Running all the examples can take a while, so if you only want to generate
specific examples, you can use the following command with a regex pattern:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make<span class="w"> </span>html<span class="w"> </span><span class="nv">EXAMPLES_PATTERN</span><span class="o">=</span>your_regex_goes_here
</pre></div>
</div>
<p>On Windows, use:</p>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>make.bat html EXAMPLES_PATTERN=your_regex_goes_here
</pre></div>
</div>
<p>This is especially helpful when you’re only modifying or checking a few examples.</p>
<p>It is also possible to build the documentation without running the examples
without running the examples by using the following command:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make<span class="w"> </span>html-noplot
</pre></div>
</div>
<p>On Windows, use:</p>
<div class="highlight-bat notranslate"><div class="highlight"><pre><span></span>make.bat html-noplot
</pre></div>
</div>
<p>This command generates the documentation without re-executing the examples, which can
take a long time. This is useful if you are only modifying the documentation itself, such as fixing
typos or improving explanations.</p>
<p><strong>Using pixi</strong></p>
<p>You can download and install pixi from <a class="reference external" href="https://pixi.sh/latest/">here</a>.</p>
<p>From the repository root:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Build documentation without running examples (faster)</span>
pixi<span class="w"> </span>run<span class="w"> </span>build-doc-quick
<span class="c1"># Build the full documentation, including examples</span>
pixi<span class="w"> </span>run<span class="w"> </span>build-doc
<span class="c1"># Clean previously built documentation</span>
pixi<span class="w"> </span>run<span class="w"> </span>clean-doc
</pre></div>
</div>
<p>The documentation will be generated in the <code class="docutils literal notranslate"><span class="pre">doc/_build/html/</span></code> directory.
You can view it by opening the local <code class="docutils literal notranslate"><span class="pre">doc/_build/html/index.html</span></code> file.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>On Intel-based macOS systems (<code class="docutils literal notranslate"><span class="pre">osx-64</span></code>), some pixi environments may not
resolve correctly due to missing upstream package builds (e.g., for PyTorch).
If you encounter issues, you can always fall back to using <code class="docutils literal notranslate"><span class="pre">make</span></code> as
described above.</p>
</div>
</section>
<section id="editing-the-api-reference-documentation">
<h3>Editing the API reference documentation<a class="headerlink" href="#editing-the-api-reference-documentation" title="Link to this heading">#</a></h3>
<p><strong>All public functions and classes must be documented in the API
reference</strong>, hence when adding a public function or class, a new entry must be
added, as detailed just above.</p>
<p>To add a new entry to the <a class="reference internal" href="reference/index.html#api-ref"><span class="std std-ref">API reference documentation</span></a> or change its
content, head to <code class="docutils literal notranslate"><span class="pre">doc/api_reference.py</span></code>. This data is then used by <code class="docutils literal notranslate"><span class="pre">doc/conf.py</span></code>
to render templates located at <code class="docutils literal notranslate"><span class="pre">doc/reference/*.rst.template</span></code>.</p>
</section>
</section>
<section id="submitting-your-code">
<h2>Submitting your code<a class="headerlink" href="#submitting-your-code" title="Link to this heading">#</a></h2>
<p>Once you have pushed your commits to your remote repository, you can submit
a PR by clicking the “Compare & pull request” button on GitHub,
targeting the skrub repository.</p>
<section id="updating-the-changelog">
<h3>Updating the changelog<a class="headerlink" href="#updating-the-changelog" title="Link to this heading">#</a></h3>
<p>Any user-facing change to the codebase needs to be reported in the changelog,
found in the <code class="docutils literal notranslate"><span class="pre">CHANGES.rst</span></code> file in the root of the repository. A user-facing
change is any change to a functionality of skrub that users are expected to interact
with: for example, adding or removing a parameter, adding a new transformer,
deprecating a function, etc.</p>
<p>Changes made in the test suite, or changes made in the
private parts of the library, should not be reported, unless they bring some benefit
to the user (such as performance improvements). Normally, changes made to the
documentation, such as typo or formatting fixes, are not reported either, while
new examples usually can be added.
Depending on the nature of the PR, a maintainer may add the “no
changelog needed” label to skip the corresponding check if a changelog entry isn’t
relevant.</p>
<p>Changelog entries need to follow a specific format: the change should be described
in sufficient detail for users to understand how they may be affected, and the
entry must list both the PR number and the GitHub username of the author(s) of the
PR.</p>
<p>Here is an example:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="w"> </span>-<span class="w"> </span>:meth:<span class="sb">`</span>DataOp.skb.apply<span class="sb">`</span><span class="w"> </span>now<span class="w"> </span>allows<span class="w"> </span>passing<span class="w"> </span>extra<span class="w"> </span>named<span class="w"> </span>arguments<span class="w"> </span>to<span class="w"> </span>the
estimator<span class="err">'</span>s<span class="w"> </span>methods<span class="w"> </span>through<span class="w"> </span>the<span class="w"> </span>parameters<span class="w"> </span><span class="sb">``</span>fit_kwargs<span class="sb">``</span>,<span class="w"> </span><span class="sb">``</span>predict_kwargs<span class="sb">``</span>
etc.<span class="w"> </span>:pr:<span class="sb">`</span><span class="m">1642</span><span class="sb">`</span><span class="w"> </span>by<span class="w"> </span>:user:<span class="sb">`</span>Jérôme<span class="w"> </span>Dockès<span class="w"> </span><jeromedockes><span class="sb">`</span>.
</pre></div>
</div>
<p>The PR number is reported with the directive <code class="docutils literal notranslate"><span class="pre">:pr:`NUMBER`</span></code>, and the author
of the PR uses the directive <code class="docutils literal notranslate"><span class="pre">:user:`AUTHOR</span> <span class="pre">NAME</span> <span class="pre"><GITHUB</span> <span class="pre">HANDLE>`</span></code>.</p>
<p>Missing changelog entries, or changelog entries that do not follow the format,
will fail the changelog check in the CI.</p>
</section>
<section id="continuous-integration-ci">
<h3>Continuous Integration (CI)<a class="headerlink" href="#continuous-integration-ci" title="Link to this heading">#</a></h3>
<p>After creating your PR, CI tools will run proceed to run all the tests on all
configurations supported by skrub.</p>
<ul class="simple">
<li><p><strong>Github Actions</strong>:
Used for testing skrub across various platforms (Linux, macOS, Windows)
and dependencies.</p></li>
<li><p><strong>CircleCI</strong>:
Builds and verifies the project documentation.</p></li>
</ul>
<p>If any of the following markers appears in the commit message, the following
actions are taken.</p>
<blockquote>
<div><div class="pst-scrollable-table-container"><table class="table">
<tbody>
<tr class="row-odd"><td><p>Commit Message Marker</p></td>
<td><p>Action Taken by CI</p></td>
</tr>
<tr class="row-even"><td><p>[ci skip]</p></td>
<td><p>CI is skipped completely</p></td>
</tr>
<tr class="row-odd"><td><p>[skip ci]</p></td>
<td><p>CI is skipped completely</p></td>
</tr>
<tr class="row-even"><td><p>[skip github]</p></td>
<td><p>CI is skipped completely</p></td>
</tr>
<tr class="row-odd"><td><p>[deps nightly]</p></td>
<td><p>CI is run with the nightly builds of dependencies</p></td>
</tr>
<tr class="row-even"><td><p>[doc skip]</p></td>
<td><p>Docs are not built</p></td>
</tr>
<tr class="row-odd"><td><p>[doc quick]</p></td>
<td><p>Docs built, but excludes example gallery plots</p></td>
</tr>
<tr class="row-even"><td><p>[doc build]</p></td>
<td><p>Docs built including example gallery plots (longer)</p></td>
</tr>
</tbody>
</table>
</div>
</div></blockquote>
<p>Note that by default the documentation is built, but only the examples that are
directly modified by the pull request are executed.</p>
<p>CI is testing all possible configurations supported by skrub, so tests may fail
with configurations different from what you are developing with. If this is the