diff --git a/.amazonq/rules/db-ux.md b/.amazonq/rules/db-ux.md new file mode 100644 index 0000000..e69de29 diff --git a/.env.template b/.env.template deleted file mode 100644 index 377a26c..0000000 --- a/.env.template +++ /dev/null @@ -1,7 +0,0 @@ -# It will force the user to add an e-mail for this project, before committing. -COMMIT_MAIL=my.commit@mail.com - -# Get credentials for public usage: -# https://marketingportal.extranet.deutschebahn.com/marketingportal/Design-Anwendungen/db-ux-design-system/resources/db-theme -ASSET_PASSWORD=ABC -ASSET_INIT_VECTOR=ABC diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 0000000..a34a0a7 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,103 @@ + +--- START: DB UX Copilot Instructions – do not edit below --- + +> **NOTE**: Always use "DB UX" components and variables as project's conventions +# @db-ux/core-components +## Best Practise / Common AI mistakes + +- always read this file if you use Components: `node_modules/@db-ux/core-components/agent/Best-Practise_Common-AI-Mistakes.md` + + +# @db-ux/core-foundations +## CSS + +- If you use CSS, follow these rules: + - Always reference the file `node_modules/@db-ux/core-foundations/agent/css/Variables.md` for variables like sizing, spacing, elevation, border, or container-size. This file contains the authoritative list of available variables. + - Use the examples provided in `Variables.md` to ensure correct usage like: + - `padding: var(--db-spacing-fixed-md);` + - `height: var(--db-sizing-md);` + - `width: var(--db-container-xs);` + - `color: var(--db-adaptive-on-bg-basic-emphasis-90-default);` + - `background-color: var(--db-adaptive-bg-basic-level-2-default);` + - `font: var(--db-type-body-sm);` + +## SCSS + +- If you use SCSS, follow these rules: + - Always reference the file `node_modules/@db-ux/core-foundations/agent/scss/Variables.md` for variables like sizing, spacing, elevation, border, or container-size. This file contains the authoritative list of available variables. + - Use the examples provided in `Variables.md` to ensure correct usage. + - Always use `@use` for imports: + - Variables: `@use "@db-ux/core-foundations/build/styles/variables";` + - Colors: `@use "@db-ux/core-foundations/build/styles/colors";` + - Fonts: `@use "@db-ux/core-foundations/build/styles/fonts";` + - Never use `as *` for the `@use`, use it like this: + - `padding: variables.$db-spacing-fixed-md;` + - `height: variables.$db-sizing-md;` + - `width: variables.$db-container-xs;` + - `color: colors.$db-adaptive-on-bg-basic-emphasis-90-default;` + - `background-color: colors.$db-adaptive-bg-basic-level-2-default;` + - `font: fonts.$db-type-body-sm;` + +## Tailwind + +- If you use Tailwind, follow these rules: + - Always reference the file `node_modules/@db-ux/core-foundations/agent/tailwind/Variables.md` for variables like sizing, spacing, elevation, border, or container-size. This file contains the authoritative list of available variables. + - Use the examples provided in `Variables.md` to ensure correct usage like: + - padding: `p-fix-md` + - height: `h-siz-md` + - width: `w-container-xs` + - color: `text-adaptive-on-bg-basic-emphasis-90-default` + - background-color: `bg-adaptive-bg-basic-level-2-default` + - font: `text-body-sm` + - Always stick to the variables. Don't use values like `p-4` or `m-[16px]`; use `p-fix-xs` or `m-fix-md` instead. + +## Figma MCP + +- If you use Figma MCP always generate code with project's conventions, such as using @db-ux/core-components and @db-ux/core-foundations. +- If a code snippet from Figma MCP has a font-family with "DB Neo Screen Head" use HTML headlines (`
+ DB is home to many exceptional product teams. Our role is to create the conditions in which + their work can thrive, scale, and continuously improve. +
++ The DB UX Design System Team works on the core content and framework of the design system, + advancing it both strategically and operationally. Our aim remains the same: to make the + system accessible to all DB employees and meaningfully support their daily work. +
++ We empower designers and engineers across DB to actively shape the system. With guidance, + shared standards, and clear contribution paths, the system grows through the expertise of + those who use it every day. This collective approach strengthens coherence, accelerates + delivery, and establishes the Design System as a shared asset for the entire organization. +
+
+
+
+
+ {text}
} +{title}
} + {headline &&{description}
} +{description}
+{description}
} + > + ) + } +