search

eclipse-tractusx / portal-frontend

Portal Frontend
Apache License 2.0
4 stars 25 forks source link

Enhance Readme file with Frontend Coding Guidelines #854

Open jjeroch opened 1 month ago

jjeroch commented 1 month ago

Description: The goal of this ticket is to enhance the project's README file by adding the frontend coding guidelines. This will include the following:

  1. Usage of the shared-component-library for design elements
  2. Implementation of text values via the locale files (de/en)
  3. Consistency of file and folder naming
  4. Any other relevant frontend coding best practices to be documented (please check carefully which guidelines we wanna share)

Tasks:

  1. Review the current README file and identify the sections that need to be updated with the frontend coding guidelines.
  2. Document the usage of the shared-component-library for design elements. This should include:
    • How to import and use the shared components
    • Naming conventions for custom components
    • Guidelines for consistent styling and theming
  3. Describe the approach for implementing text values via the locale files (de/en). This should cover:
    • Folder structure for locale files
    • Naming conventions for locale keys
    • How to access and use the locale values in the codebase
  4. Identify and document any other relevant frontend coding best practices that should be followed, such as:
    • Consistency of file and folder naming
    • Code formatting and linting
    • Handling of API responses and error states
    • Consistent use of state management patterns
  5. Update the README file with the new frontend coding guidelines section.
  6. Review the changes and ensure the guidelines are clear and comprehensive.
  7. Commit the changes to the repository.