Skip to content

Commit

Permalink
docs(style-guide): create content
Browse files Browse the repository at this point in the history
chore: squash with style guide
  • Loading branch information
HasithDeAlwis committed Dec 23, 2024
1 parent 7a64766 commit 2f0d3fc
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"unit-testing",
"front-end",
"back-end",
"tooling"
"tooling",
"style-guide"
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: Style Guide
description: WIP
icon: PenTool
---

## Inspiration
Our style guide is an extension of the [Angular Style Guide](https://angular.dev/style-guide).
<iframe
title="Conventional Commits Website"
className="mt-4 w-full h-[400px] rounded-lg"
src="https://angular.dev/style-guide"
allowFullScreen>
</iframe>

## Overview

### File Naming Convention
We follow the Angular style guide for naming files. The file name should be in kebab-case, not capitalized, and should describe the content of the file. For example, a component file should be named `event-card.component.ts`.

**Note:** Presenter and component files must be prefixed with a `.presenter` or a `.container` and do not need a `.component` suffix

Examples:
- `event-card.component.tsx`
- `event-card.container.tsx`
- `event-card.presenter.tsx`
- `event.service.tsx`
- `event.helper.tsx`

0 comments on commit 2f0d3fc

Please sign in to comment.