Skip to content

Commit ce0f3e1

Browse files
authored
📖 Add readme blurb about dir structure (#1281)
Example of proposed directory structure: ├── pages/ │ ├── assessment-management/ │ │ ├── assessment-settings/ │ │ │ ├── assessment-settings-page.tsx │ │ │ └── components/ │ │ │ └── assessment-settings-presentation-layer-component-example.tsx │ │ ├── questionnaire/ │ │ │ ├── questionnaire-page.tsx │ │ │ └── components/ │ │ │ ├── questionnaire-form.tsx │ │ │ ├── questionnaire-header.tsx │ │ │ └── questionnaire-side-nav.tsx │ │ ├── hooks/ │ │ └── utils/ │ └── ... └── ... Signed-off-by: ibolton336 <[email protected]>
1 parent c3805fa commit ce0f3e1

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,12 @@ Please read the [Pull Request (PR) Process](https://github.com/konveyor/release-
215215
section of the [Konveyor versioning and branching doc](https://github.com/konveyor/release-tools/blob/main/VERSIONING.md)
216216
for more information.
217217
218+
## File Naming Conventions
219+
220+
- Use kebab-case for file names.
221+
- The root page/parent level components are placed directly in their respective directories.
222+
- Presentation layer components are placed within the `components/` subdirectory of the parent component.
223+
218224
# Contributing
219225
220226
We welcome contributions to this project! If you're interested in contributing,

0 commit comments

Comments
 (0)