Skip to content

Commit 6f3a1ab

Browse files
Move ADRs into history (#2246)
* add dates to history page * remove ADRs guide * move naming conventions non-decision into best practices * remove disclaimer from best practices guide * integrate ADRs into History page * Fix final line endings * lints * typo * Update docs/history.md --------- Co-authored-by: GitHub Actions Bot <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 828fc4f commit 6f3a1ab

7 files changed

+199
-292
lines changed

docs/adrs/0001-record-architecture-decisions.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

docs/adrs/0002-naming-conventions-for-view-components.md

Lines changed: 0 additions & 33 deletions
This file was deleted.

docs/adrs/0003-polymorphic-slot-definitions.md

Lines changed: 0 additions & 126 deletions
This file was deleted.

docs/adrs/0004-slots-separate-getter-setter.md

Lines changed: 0 additions & 93 deletions
This file was deleted.

docs/adrs/index.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/best_practices.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ nav_order: 5
66

77
# Best practices
88

9-
_A general guide to building component-driven UI in Rails. Consider it to be more opinion than fact._
10-
119
## Philosophy
1210

1311
### Why ViewComponent exists
@@ -60,6 +58,10 @@ When building ViewComponents, look for opportunities to consolidate similar patt
6058

6159
Aim to minimize the amount of single-use view code. Every new component introduced adds to application maintenance burden.
6260

61+
### Use -Component suffix
62+
63+
While it means class names are longer and perhaps less readable, including the -`Component` suffix in component names makes it clear that the class is a component, following Rails convention of using suffixes for all non-model objects.
64+
6365
## Implementation
6466

6567
### Avoid inheritance

0 commit comments

Comments
 (0)