diff --git a/docs/react/components.md b/docs/react/components.md new file mode 100644 index 0000000..b3203a7 --- /dev/null +++ b/docs/react/components.md @@ -0,0 +1,23 @@ +--- +id: components +title: Components +sidebar_label: Components +--- + +#### The following convention should be followed for components naming: + +* `PascalCase` should be used to name the component file. +* Name of the component should match the filename + * It should be understandable by everyone (no **EntityForListItem) + * it should be simple to use (no SimpleBeanFactoryAwareAspectInstanceFactory) +
+ ``` + const SumbitButton = (props: SubmitButtonProps) => { + return ( +
+ .... +
+ ) + } + ``` + diff --git a/docs/react/files.md b/docs/react/files.md new file mode 100644 index 0000000..c4d1fc3 --- /dev/null +++ b/docs/react/files.md @@ -0,0 +1,30 @@ +--- +id: files +title: Files +sidebar_label: Files +--- + +#### The following convention should be followed for different files name: + +* **Interfaces** - + * `PascalCase` should be used for the interfaces names. + * Files could be categorized into folders like + ``` + > domain + > requests + > responses + > states + > others + ``` + +* **Enums** - + * `PascalCase` should be used for the enum file names. + * Enums could be organized into folder like + ``` + > enums + Roles.ts + UserType.ts + ``` +* **Constants** - + * `camelCase` should be used for constants file names. + \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index 19e521c..f6a8c13 100644 --- a/sidebars.js +++ b/sidebars.js @@ -43,8 +43,8 @@ module.exports = "type": "category", "label": "Practices and Tools", "items": [ - "python/general", - "python/tools" + "python/general", + "python/tools" ] }, "python/docstrings", @@ -80,6 +80,16 @@ module.exports = ] } ], + "React (TypeScript)": [ + { + "type": "category", + "label": "Naming Conventions", + "items": [ + "react/components", + "react/files" + ] + } + ], "Java": [ { "type": "category", @@ -102,15 +112,15 @@ module.exports = ] } ], - "NoSQL" : [ + "NoSQL": [ { "type": "category", "label": "Document DB", "items": [ - "nosql/documentdb/document-db-naming-convention", - "nosql/documentdb/one-to-one-relationship", - "nosql/documentdb/one-to-many-relationship", - "nosql/documentdb/many-to-many-relationship" + "nosql/documentdb/document-db-naming-convention", + "nosql/documentdb/one-to-one-relationship", + "nosql/documentdb/one-to-many-relationship", + "nosql/documentdb/many-to-many-relationship" ] } ],