BoilerWorks

boilerworks / contributing / index.html
Source Rendered
Blame History Raw 1223 lines
1
2
<!doctype html>
3
<html lang="en" class="no-js">
4
<head>
5
6
<meta charset="utf-8">
7
<meta name="viewport" content="width=device-width,initial-scale=1">
8
9
<meta name="description" content="The CLI for boilerworks.ai — stop vibe-coding scaffolding">
10
11
12
<meta name="author" content="CONFLICT LLC">
13
14
15
<link rel="canonical" href="https://boilerworks.dev/contributing/">
16
17
18
<link rel="prev" href="../cli/bootstrap/">
19
20
21
22
23
24
25
<link rel="icon" href="../assets/images/favicon.png">
26
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">
27
28
29
30
<title>Contributing - Boilerworks</title>
31
32
33
34
<link rel="stylesheet" href="../assets/stylesheets/main.484c7ddc.min.css">
35
36
37
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
38
39
40
41
42
43
44
45
46
47
48
49
50
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
51
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
52
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
53
54
55
56
<link rel="stylesheet" href="../assets/css/custom.css">
57
58
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
59
60
61
62
63
64
</head>
65
66
67
68
69
70
71
72
73
74
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom">
75
76
77
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
78
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
79
<label class="md-overlay" for="__drawer"></label>
80
<div data-md-component="skip">
81
82
83
<a href="#contributing" class="md-skip">
84
Skip to content
85
</a>
86
87
</div>
88
<div data-md-component="announce">
89
90
</div>
91
92
93
94
95
<header class="md-header" data-md-component="header">
96
<nav class="md-header__inner md-grid" aria-label="Header">
97
<a href=".." title="Boilerworks" class="md-header__button md-logo" aria-label="Boilerworks" data-md-component="logo">
98
99
<img src="../assets/images/logo.svg" alt="logo">
100
101
</a>
102
<label class="md-header__button md-icon" for="__drawer">
103
104
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
105
</label>
106
<div class="md-header__title" data-md-component="header-title">
107
<div class="md-header__ellipsis">
108
<div class="md-header__topic">
109
<span class="md-ellipsis">
110
Boilerworks
111
</span>
112
</div>
113
<div class="md-header__topic" data-md-component="header-topic">
114
<span class="md-ellipsis">
115
116
Contributing
117
118
</span>
119
</div>
120
</div>
121
</div>
122
123
124
<form class="md-header__option" data-md-component="palette">
125
126
127
128
129
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
130
131
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
132
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
133
</label>
134
135
136
137
138
139
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
140
141
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_0" hidden>
142
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
143
</label>
144
145
146
</form>
147
148
149
150
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
151
152
153
154
155
156
<label class="md-header__button md-icon" for="__search">
157
158
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
159
</label>
160
<div class="md-search" data-md-component="search" role="dialog">
161
<label class="md-search__overlay" for="__search"></label>
162
<div class="md-search__inner" role="search">
163
<form class="md-search__form" name="search">
164
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
165
<label class="md-search__icon md-icon" for="__search">
166
167
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
168
169
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
170
</label>
171
<nav class="md-search__options" aria-label="Search">
172
173
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
174
175
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
176
</button>
177
</nav>
178
179
<div class="md-search__suggest" data-md-component="search-suggest"></div>
180
181
</form>
182
<div class="md-search__output">
183
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
184
<div class="md-search-result" data-md-component="search-result">
185
<div class="md-search-result__meta">
186
Initializing search
187
</div>
188
<ol class="md-search-result__list" role="presentation"></ol>
189
</div>
190
</div>
191
</div>
192
</div>
193
</div>
194
195
196
197
<div class="md-header__source">
198
<a href="https://github.com/ConflictHQ/boilerworks" title="Go to repository" class="md-source" data-md-component="source">
199
<div class="md-source__icon md-icon">
200
201
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
202
</div>
203
<div class="md-source__repository">
204
ConflictHQ/boilerworks
205
</div>
206
</a>
207
</div>
208
209
</nav>
210
211
</header>
212
213
<div class="md-container" data-md-component="container">
214
215
216
217
218
219
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
220
<div class="md-grid">
221
<ul class="md-tabs__list">
222
223
224
225
226
227
228
<li class="md-tabs__item">
229
<a href=".." class="md-tabs__link">
230
231
232
233
234
235
Home
236
237
</a>
238
</li>
239
240
241
242
243
244
245
246
247
248
249
<li class="md-tabs__item">
250
<a href="../getting-started/installation/" class="md-tabs__link">
251
252
253
254
Getting Started
255
256
</a>
257
</li>
258
259
260
261
262
263
264
265
266
267
268
269
<li class="md-tabs__item">
270
<a href="../guide/templates/" class="md-tabs__link">
271
272
273
274
Templates
275
276
</a>
277
</li>
278
279
280
281
282
283
284
285
286
287
288
289
<li class="md-tabs__item">
290
<a href="../cli/setup/" class="md-tabs__link">
291
292
293
294
CLI Reference
295
296
</a>
297
</li>
298
299
300
301
302
303
304
305
306
307
308
309
<li class="md-tabs__item md-tabs__item--active">
310
<a href="./" class="md-tabs__link">
311
312
313
314
315
316
Contributing
317
318
</a>
319
</li>
320
321
322
323
</ul>
324
</div>
325
</nav>
326
327
328
329
<main class="md-main" data-md-component="main">
330
<div class="md-main__inner md-grid">
331
332
333
334
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
335
<div class="md-sidebar__scrollwrap">
336
<div class="md-sidebar__inner">
337
338
339
340
341
342
343
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
344
<label class="md-nav__title" for="__drawer">
345
<a href=".." title="Boilerworks" class="md-nav__button md-logo" aria-label="Boilerworks" data-md-component="logo">
346
347
<img src="../assets/images/logo.svg" alt="logo">
348
349
</a>
350
Boilerworks
351
</label>
352
353
<div class="md-nav__source">
354
<a href="https://github.com/ConflictHQ/boilerworks" title="Go to repository" class="md-source" data-md-component="source">
355
<div class="md-source__icon md-icon">
356
357
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
358
</div>
359
<div class="md-source__repository">
360
ConflictHQ/boilerworks
361
</div>
362
</a>
363
</div>
364
365
<ul class="md-nav__list" data-md-scrollfix>
366
367
368
369
370
371
372
373
<li class="md-nav__item">
374
<a href=".." class="md-nav__link">
375
376
377
378
<span class="md-ellipsis">
379
380
381
Home
382
383
384
385
</span>
386
387
388
389
</a>
390
</li>
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
<li class="md-nav__item md-nav__item--nested">
411
412
413
414
415
416
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
417
418
419
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
420
421
422
423
<span class="md-ellipsis">
424
425
426
Getting Started
427
428
429
430
</span>
431
432
433
434
<span class="md-nav__icon md-icon"></span>
435
</label>
436
437
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
438
<label class="md-nav__title" for="__nav_2">
439
<span class="md-nav__icon md-icon"></span>
440
441
442
Getting Started
443
444
445
</label>
446
<ul class="md-nav__list" data-md-scrollfix>
447
448
449
450
451
452
453
454
<li class="md-nav__item">
455
<a href="../getting-started/installation/" class="md-nav__link">
456
457
458
459
<span class="md-ellipsis">
460
461
462
Installation
463
464
465
466
</span>
467
468
469
470
</a>
471
</li>
472
473
474
475
476
477
478
479
480
481
482
<li class="md-nav__item">
483
<a href="../getting-started/quickstart/" class="md-nav__link">
484
485
486
487
<span class="md-ellipsis">
488
489
490
Quick Start
491
492
493
494
</span>
495
496
497
498
</a>
499
</li>
500
501
502
503
504
505
506
507
508
509
510
<li class="md-nav__item">
511
<a href="../getting-started/configuration/" class="md-nav__link">
512
513
514
515
<span class="md-ellipsis">
516
517
518
Configuration
519
520
521
522
</span>
523
524
525
526
</a>
527
</li>
528
529
530
531
532
</ul>
533
</nav>
534
535
</li>
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
<li class="md-nav__item md-nav__item--nested">
556
557
558
559
560
561
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
562
563
564
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
565
566
567
568
<span class="md-ellipsis">
569
570
571
Templates
572
573
574
575
</span>
576
577
578
579
<span class="md-nav__icon md-icon"></span>
580
</label>
581
582
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
583
<label class="md-nav__title" for="__nav_3">
584
<span class="md-nav__icon md-icon"></span>
585
586
587
Templates
588
589
590
</label>
591
<ul class="md-nav__list" data-md-scrollfix>
592
593
594
595
596
597
598
599
<li class="md-nav__item">
600
<a href="../guide/templates/" class="md-nav__link">
601
602
603
604
<span class="md-ellipsis">
605
606
607
Catalogue
608
609
610
611
</span>
612
613
614
615
</a>
616
</li>
617
618
619
620
621
622
623
624
625
626
627
<li class="md-nav__item">
628
<a href="../guide/choosing/" class="md-nav__link">
629
630
631
632
<span class="md-ellipsis">
633
634
635
Choosing a Template
636
637
638
639
</span>
640
641
642
643
</a>
644
</li>
645
646
647
648
649
</ul>
650
</nav>
651
652
</li>
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
<li class="md-nav__item md-nav__item--nested">
673
674
675
676
677
678
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
679
680
681
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
682
683
684
685
<span class="md-ellipsis">
686
687
688
CLI Reference
689
690
691
692
</span>
693
694
695
696
<span class="md-nav__icon md-icon"></span>
697
</label>
698
699
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
700
<label class="md-nav__title" for="__nav_4">
701
<span class="md-nav__icon md-icon"></span>
702
703
704
CLI Reference
705
706
707
</label>
708
<ul class="md-nav__list" data-md-scrollfix>
709
710
711
712
713
714
715
716
<li class="md-nav__item">
717
<a href="../cli/setup/" class="md-nav__link">
718
719
720
721
<span class="md-ellipsis">
722
723
724
setup
725
726
727
728
</span>
729
730
731
732
</a>
733
</li>
734
735
736
737
738
739
740
741
742
743
744
<li class="md-nav__item">
745
<a href="../cli/init/" class="md-nav__link">
746
747
748
749
<span class="md-ellipsis">
750
751
752
init
753
754
755
756
</span>
757
758
759
760
</a>
761
</li>
762
763
764
765
766
767
768
769
770
771
772
<li class="md-nav__item">
773
<a href="../cli/list/" class="md-nav__link">
774
775
776
777
<span class="md-ellipsis">
778
779
780
list
781
782
783
784
</span>
785
786
787
788
</a>
789
</li>
790
791
792
793
794
795
796
797
798
799
800
<li class="md-nav__item">
801
<a href="../cli/bootstrap/" class="md-nav__link">
802
803
804
805
<span class="md-ellipsis">
806
807
808
bootstrap
809
810
811
812
</span>
813
814
815
816
</a>
817
</li>
818
819
820
821
822
</ul>
823
</nav>
824
825
</li>
826
827
828
829
830
831
832
833
834
835
836
837
<li class="md-nav__item md-nav__item--active">
838
839
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
840
841
842
843
844
845
<label class="md-nav__link md-nav__link--active" for="__toc">
846
847
848
849
<span class="md-ellipsis">
850
851
852
Contributing
853
854
855
856
</span>
857
858
859
860
<span class="md-nav__icon md-icon"></span>
861
</label>
862
863
<a href="./" class="md-nav__link md-nav__link--active">
864
865
866
867
<span class="md-ellipsis">
868
869
870
Contributing
871
872
873
874
</span>
875
876
877
878
</a>
879
880
881
882
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
883
884
885
886
887
888
889
<label class="md-nav__title" for="__toc">
890
<span class="md-nav__icon md-icon"></span>
891
Table of contents
892
</label>
893
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
894
895
<li class="md-nav__item">
896
<a href="#ways-to-contribute" class="md-nav__link">
897
<span class="md-ellipsis">
898
899
Ways to contribute
900
901
</span>
902
</a>
903
904
</li>
905
906
<li class="md-nav__item">
907
<a href="#template-conventions" class="md-nav__link">
908
<span class="md-ellipsis">
909
910
Template conventions
911
912
</span>
913
</a>
914
915
</li>
916
917
<li class="md-nav__item">
918
<a href="#cli-development" class="md-nav__link">
919
<span class="md-ellipsis">
920
921
CLI development
922
923
</span>
924
</a>
925
926
</li>
927
928
<li class="md-nav__item">
929
<a href="#adding-a-template-to-the-catalogue" class="md-nav__link">
930
<span class="md-ellipsis">
931
932
Adding a template to the catalogue
933
934
</span>
935
</a>
936
937
</li>
938
939
<li class="md-nav__item">
940
<a href="#code-standards" class="md-nav__link">
941
<span class="md-ellipsis">
942
943
Code standards
944
945
</span>
946
</a>
947
948
</li>
949
950
<li class="md-nav__item">
951
<a href="#issues-and-prs" class="md-nav__link">
952
<span class="md-ellipsis">
953
954
Issues and PRs
955
956
</span>
957
</a>
958
959
</li>
960
961
</ul>
962
963
</nav>
964
965
</li>
966
967
968
969
</ul>
970
</nav>
971
</div>
972
</div>
973
</div>
974
975
976
977
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
978
<div class="md-sidebar__scrollwrap">
979
<div class="md-sidebar__inner">
980
981
982
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
983
984
985
986
987
988
989
<label class="md-nav__title" for="__toc">
990
<span class="md-nav__icon md-icon"></span>
991
Table of contents
992
</label>
993
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
994
995
<li class="md-nav__item">
996
<a href="#ways-to-contribute" class="md-nav__link">
997
<span class="md-ellipsis">
998
999
Ways to contribute
1000
1001
</span>
1002
</a>
1003
1004
</li>
1005
1006
<li class="md-nav__item">
1007
<a href="#template-conventions" class="md-nav__link">
1008
<span class="md-ellipsis">
1009
1010
Template conventions
1011
1012
</span>
1013
</a>
1014
1015
</li>
1016
1017
<li class="md-nav__item">
1018
<a href="#cli-development" class="md-nav__link">
1019
<span class="md-ellipsis">
1020
1021
CLI development
1022
1023
</span>
1024
</a>
1025
1026
</li>
1027
1028
<li class="md-nav__item">
1029
<a href="#adding-a-template-to-the-catalogue" class="md-nav__link">
1030
<span class="md-ellipsis">
1031
1032
Adding a template to the catalogue
1033
1034
</span>
1035
</a>
1036
1037
</li>
1038
1039
<li class="md-nav__item">
1040
<a href="#code-standards" class="md-nav__link">
1041
<span class="md-ellipsis">
1042
1043
Code standards
1044
1045
</span>
1046
</a>
1047
1048
</li>
1049
1050
<li class="md-nav__item">
1051
<a href="#issues-and-prs" class="md-nav__link">
1052
<span class="md-ellipsis">
1053
1054
Issues and PRs
1055
1056
</span>
1057
</a>
1058
1059
</li>
1060
1061
</ul>
1062
1063
</nav>
1064
</div>
1065
</div>
1066
</div>
1067
1068
1069
1070
<div class="md-content" data-md-component="content">
1071
1072
<article class="md-content__inner md-typeset">
1073
1074
1075
1076
1077
1078
1079
1080
1081
<h1 id="contributing">Contributing<a class="headerlink" href="#contributing" title="Permanent link">&para;</a></h1>
1082
<h2 id="ways-to-contribute">Ways to contribute<a class="headerlink" href="#ways-to-contribute" title="Permanent link">&para;</a></h2>
1083
<ul>
1084
<li><strong>Add a template</strong> — build a new stack using the <a href="https://github.com/ConflictHQ/boilerworks/blob/main/primers/PROCESS.md">boilerworks conventions</a> and open a PR to add it to the catalogue</li>
1085
<li><strong>Improve docs</strong> — fix errors, improve clarity, add examples</li>
1086
<li><strong>Report bugs</strong> — open an issue with steps to reproduce</li>
1087
<li><strong>Request a template</strong> — open an issue describing the stack</li>
1088
</ul>
1089
<h2 id="template-conventions">Template conventions<a class="headerlink" href="#template-conventions" title="Permanent link">&para;</a></h2>
1090
<p>All templates must:</p>
1091
<ul>
1092
<li>Boot with <code>docker compose up -d</code> from scratch (no local installs required)</li>
1093
<li>Use standard ports (app: 3000/8000, postgres: 5432, redis: 6379)</li>
1094
<li>Use <code>boilerworks</code> as the placeholder name throughout (the renderer replaces it)</li>
1095
<li>Include: Items, Categories, FormDefinitions, FormSubmissions, WorkflowDefinitions (Full only)</li>
1096
<li>Have health check at <code>/up</code> or <code>/health/</code></li>
1097
<li>Include a <code>CLAUDE.md</code> pointing to <code>bootstrap.md</code></li>
1098
<li>Pass <code>make test</code> and <code>make lint</code></li>
1099
</ul>
1100
<h2 id="cli-development">CLI development<a class="headerlink" href="#cli-development" title="Permanent link">&para;</a></h2>
1101
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/ConflictHQ/boilerworks.git
1102
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="nb">cd</span><span class="w"> </span>boilerworks
1103
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>uv<span class="w"> </span>sync
1104
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>uv<span class="w"> </span>run<span class="w"> </span>boilerworks<span class="w"> </span>--help
1105
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>
1106
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>make<span class="w"> </span>lint<span class="w"> </span><span class="c1"># ruff check + format --check</span>
1107
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a>make<span class="w"> </span><span class="nb">test</span><span class="w"> </span><span class="c1"># pytest with coverage</span>
1108
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>make<span class="w"> </span>format<span class="w"> </span><span class="c1"># ruff fix + format</span>
1109
</code></pre></div>
1110
<p>Coverage must stay at ≥ 80%.</p>
1111
<h2 id="adding-a-template-to-the-catalogue">Adding a template to the catalogue<a class="headerlink" href="#adding-a-template-to-the-catalogue" title="Permanent link">&para;</a></h2>
1112
<ol>
1113
<li>Build and test the template repo (must live at <code>ConflictHQ/boilerworks-{name}</code>)</li>
1114
<li>Edit <code>data/templates.yaml</code> — add an entry with <code>name</code>, <code>repo</code>, <code>size</code>, <code>language</code>, <code>status</code>, <code>description</code>, <code>topologies</code></li>
1115
<li>Run <code>make test</code> — <code>test_registry.py</code> will catch count or schema mismatches</li>
1116
<li>Open a PR</li>
1117
</ol>
1118
<h2 id="code-standards">Code standards<a class="headerlink" href="#code-standards" title="Permanent link">&para;</a></h2>
1119
<ul>
1120
<li>Python 3.12+, fully typed</li>
1121
<li>Line length: 120 (ruff config in <code>pyproject.toml</code>)</li>
1122
<li><code>ruff check . &amp;&amp; ruff format .</code> before every commit</li>
1123
<li>No TODOs, no stubs</li>
1124
<li>No co-authorship messages in commits</li>
1125
</ul>
1126
<h2 id="issues-and-prs">Issues and PRs<a class="headerlink" href="#issues-and-prs" title="Permanent link">&para;</a></h2>
1127
<p><a href="https://github.com/ConflictHQ/boilerworks/issues">github.com/ConflictHQ/boilerworks/issues</a></p>
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
</article>
1142
</div>
1143
1144
1145
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
1146
1147
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
1148
</div>
1149
1150
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
1151
1152
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
1153
Back to top
1154
</button>
1155
1156
</main>
1157
1158
<footer class="md-footer">
1159
1160
<div class="md-footer-meta md-typeset">
1161
<div class="md-footer-meta__inner md-grid">
1162
<div class="md-copyright">
1163
1164
<div class="md-copyright__highlight">
1165
Copyright &copy; 2026 CONFLICT LLC
1166
</div>
1167
1168
1169
Made with
1170
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1171
Material for MkDocs
1172
</a>
1173
1174
</div>
1175
1176
1177
<div class="md-social">
1178
1179
1180
1181
1182
1183
1184
1185
1186
<a href="https://github.com/ConflictHQ/boilerworks" target="_blank" rel="noopener" title="github.com" class="md-social__link">
1187
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
1188
</a>
1189
1190
1191
1192
1193
1194
1195
1196
1197
<a href="https://boilerworks.ai" target="_blank" rel="noopener" title="boilerworks.ai" class="md-social__link">
1198
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M351.9 280H161c2.9 64.5 17.2 123.9 37.5 167.4 11.4 24.5 23.7 41.8 35.1 52.4 11.2 10.5 18.9 12.2 22.9 12.2s11.7-1.7 22.9-12.2c11.4-10.6 23.7-28 35.1-52.4 20.3-43.5 34.6-102.9 37.5-167.4zm-191-48h190.9c-2.8-64.5-17.1-123.9-37.4-167.4-11.4-24.4-23.7-41.8-35.1-52.4C268.1 1.7 260.4 0 256.4 0s-11.7 1.7-22.9 12.2c-11.4 10.6-23.7 28-35.1 52.4-20.3 43.5-34.6 102.9-37.5 167.4m-48 0c3.5-85.6 25.6-165.1 57.9-217.3C78.7 47.3 10.9 131.2 1.5 232zM1.5 280c9.4 100.8 77.2 184.7 169.3 217.3-32.3-52.2-54.4-131.7-57.9-217.3zm398.4 0c-3.5 85.6-25.6 165.1-57.9 217.3 92.1-32.7 159.9-116.5 169.3-217.3zm111.4-48C501.9 131.2 434.1 47.3 342 14.7c32.3 52.2 54.4 131.7 57.9 217.3z"/></svg>
1199
</a>
1200
1201
</div>
1202
1203
</div>
1204
</div>
1205
</footer>
1206
1207
</div>
1208
<div class="md-dialog" data-md-component="dialog">
1209
<div class="md-dialog__inner md-typeset"></div>
1210
</div>
1211
1212
1213
1214
1215
1216
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.instant", "navigation.tabs", "navigation.sections", "navigation.expand", "navigation.top", "search.suggest", "search.highlight", "content.code.copy", "content.tabs.link", "header.autohide"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
1217
1218
1219
<script src="../assets/javascripts/bundle.79ae519e.min.js"></script>
1220
1221
1222
</body>
1223
</html>

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button