diff --git a/.github/review-instructions.md b/.github/review-instructions.md index faf33970b..021bf9134 100644 --- a/.github/review-instructions.md +++ b/.github/review-instructions.md @@ -4,6 +4,8 @@ When conducting a code review, follow these steps to ensure a thorough and constructive process. +**Ensure that all review guidelines are followed. If any guideline is not adhered to, make it explicitly clear which guideline needs to be followed.** + ## Review Process 1. 🎯 **Key Issues** @@ -26,20 +28,3 @@ When conducting a code review, follow these steps to ensure a thorough and const - ⚠️ Warnings - 💡 Suggestions - ✅ Good practices - -## Testing Requirements - -- Ensure the code includes appropriate unit tests using Jest and Spectator. -- Verify that error cases are tested. -- Follow the Arrange-Act-Assert pattern in test cases. - -## Code Style - -- Adhere to the project's [Code Style Guidelines](/docs/code-style.md). -- Prioritize TypeScript type safety and Clean Code principles. - -## Additional Notes - -- If the code or question is unclear, ask for clarification before proceeding. -- Avoid generic feedback; tailor your review to the specific code or problem. -- Keep the current development phase in mind as outlined in [Development Phases](/docs/phases). diff --git a/docs/guidelines/code-style.md b/docs/guidelines/code-style.md index ca2e4c8c0..288554497 100644 --- a/docs/guidelines/code-style.md +++ b/docs/guidelines/code-style.md @@ -22,7 +22,7 @@ This section extends the core code style principles with Angular-specific and ad - **Strict Type Checking**: Enable strict mode (`strict: true`) and avoid excessive use of `any`. - **Interfaces vs. Types**: Prefer interfaces for object definitions and use type aliases for unions and intersections. - **Generics**: Use meaningful type parameter names and constrain generics when applicable. -- **Documentation**: Employ JSDoc comments for complex functions and generic parameters to improve code clarity. +- **Documentation**: Employ JSDoc comments functions and generic parameters to improve code clarity. ## TypeScript Guidelines diff --git a/docs/tech-stack.md b/docs/tech-stack.md index 9639aa8e4..987bbc755 100644 --- a/docs/tech-stack.md +++ b/docs/tech-stack.md @@ -64,6 +64,44 @@ - Modern JavaScript date utility library - Used for consistent date formatting and manipulation - Tree-shakeable to optimize bundle size +- **[Lodash](https://lodash.com/)** + - Utility library for common JavaScript tasks +- **[UUID](https://www.npmjs.com/package/uuid)** + - Generates unique identifiers +- **[Zod](https://github.com/colinhacks/zod)** + - TypeScript-first schema validation library + +## Additional Technical Areas + +### Authentication & Authorization + +- **[angular-oauth2-oidc](https://github.com/manfredsteyer/angular-oauth2-oidc)** + - Simplifies implementing OAuth2 and OIDC authentication in Angular. +- **[angular-oauth2-oidc-jwks](https://github.com/manfredsteyer/angular-oauth2-oidc)** + - Adds JWKS support for secure token management. + +### Real-Time Communication + +- **[@microsoft/signalr](https://www.npmjs.com/package/@microsoft/signalr)** + - Provides real-time communication between client and server components. + +### Barcode Scanning + +- **[Scandit Web Data Capture Barcode](https://www.scandit.com/documentation/web/)** + - Robust barcode scanning capabilities integrated into the application. +- **[Scandit Web Data Capture Core](https://www.scandit.com/documentation/web/)** + - Core library supporting the barcode scanning features. + +### Tooling + +- **[Nx](https://nx.dev/)** + - Powerful monorepo tool for Angular and other frontend applications. +- **[Husky](https://typicode.github.io/husky/#/)** + - Manages Git hooks for consistent developer workflows. +- **[ESLint](https://eslint.org/) & [Prettier](https://prettier.io/)** + - Linting and formatting tools to maintain consistent code quality. +- **[Storybook](https://storybook.js.org/)** + - Isolated component development and living documentation environment. ## Development Environment Setup @@ -84,7 +122,7 @@ 3. **Getting Started** ```bash npm install # Install dependencies - npm run start # Start development server - npm run test # Run tests - npm run storybook # Start Storybook + npm run start # Start development server + npm run test # Run tests + npm run storybook # Start Storybook ``` diff --git a/libs/ui/input-controls/src/input-controls.scss b/libs/ui/input-controls/src/input-controls.scss index fa80fd4ac..0673e2ceb 100644 --- a/libs/ui/input-controls/src/input-controls.scss +++ b/libs/ui/input-controls/src/input-controls.scss @@ -1,3 +1,3 @@ @use "./lib/checkbox/checkbox"; -@use "./lib/chips/chip-option"; +@use "./lib/chips/chips"; @use "./lib/dropdown/dropdown";