Skip to content

Commit 24826f0

Browse files
authored
Establish demo naming and README standards
1 parent c522a46 commit 24826f0

File tree

1 file changed

+76
-0
lines changed

1 file changed

+76
-0
lines changed

CONTRIBUTING.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,3 +273,79 @@ Run `docker-compose build tests` to build the tests container. Run `docker-compo
273273
What do project maintainers do? What sort of work is involved? [sstephenson](https://github.com/sstephenson) wrote in the [turbolinks](https://github.com/turbolinks/turbolinks) repo:
274274

275275
> [Why this is not still fully merged?](https://github.com/turbolinks/turbolinks/pull/124#issuecomment-239826060)
276+
277+
# 📦 Demo Naming and README Standards
278+
279+
To keep our React on Rails demos clear, discoverable, and SEO-friendly, all demo repos follow a standardized naming and documentation structure.
280+
281+
---
282+
283+
## ✅ Repository Naming Convention
284+
285+
Use the format:
286+
287+
```
288+
react_on_rails-demo-v[REACT_ON_RAILS_VERSION]-[key-topics]
289+
```
290+
291+
**Examples:**
292+
293+
- `react_on_rails-demo-v15-ssr-auto-registration-bundle-splitting`
294+
- `react_on_rails-demo-v15-react-server-components`
295+
- `react_on_rails-demo-v15-typescript-setup`
296+
- `react_on_rails-demo-v15-cypress-setup`
297+
298+
**Why this format?**
299+
300+
- Clear versioning and purpose
301+
- Easy to discover in GitHub, search engines, and documentation
302+
- Consistent prefix for grouping demos together
303+
304+
---
305+
306+
## 📝 README Title Format
307+
308+
```
309+
# React on Rails Demo: [Topics] with v[VERSION] and Rails [VERSION]
310+
```
311+
312+
**Example:**
313+
314+
```
315+
# React on Rails Demo: SSR, Auto-Registration & Bundle Splitting with v15 and Rails 8
316+
```
317+
318+
---
319+
320+
## 📄 README Description Template
321+
322+
```
323+
A fully working demo of React on Rails v[VERSION] on Rails [VERSION], showcasing [topics].
324+
325+
✅ Includes:
326+
- [Topic 1]
327+
- [Topic 2]
328+
- [Topic 3]
329+
330+
📂 Repo name: `react_on_rails-demo-v[VERSION]-[topics]`
331+
332+
📚 Part of the [React on Rails Demo Series](https://github.com/shakacode?tab=repositories&q=react_on_rails-demo)
333+
```
334+
335+
**Example:**
336+
337+
```
338+
A fully working demo of React on Rails v15 on Rails 8, showcasing server-side rendering, file-system-based auto-registration, and intelligent bundle splitting.
339+
340+
✅ Includes:
341+
- Server-Side Rendering (SSR)
342+
- Auto-discovered components based on file structure
343+
- Lightweight vs. heavy component splitting
344+
- Fix for “package.json not found” install bug
345+
346+
📂 Repo name: `react_on_rails-demo-v15-ssr-auto-registration-bundle-splitting`
347+
348+
📚 Part of the [React on Rails Demo Series](https://github.com/shakacode?tab=repositories&q=react_on_rails-demo)
349+
```
350+
351+

0 commit comments

Comments
 (0)