-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
2 changed files
with
30 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,6 +4,7 @@ | |
"unit-testing", | ||
"front-end", | ||
"back-end", | ||
"tooling" | ||
"tooling", | ||
"style-guide" | ||
] | ||
} |
28 changes: 28 additions & 0 deletions
28
apps/docs/content/docs/contribution-guidelines/coding-standards/style-guide.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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` |