build: basic setup

sbb-design-systems · Dec 10, 2024 · b803d18 · b803d18
1 parent 4b16b3e
commit b803d18
Show file tree

Hide file tree

Showing 60 changed files with 10,617 additions and 15,055 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1,5 @@
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# global owners will be requested for
+# review when someone opens a pull request.
+* @kyubisation @jeripeierSBB
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,126 @@
+name: Bug Report
+description: File a bug report
+title: '[Bug]: '
+labels: 'type: bug 🐛'
+assignees:
+  - octocat
+body:
+  - type: markdown
+    attributes:
+      value: |
+        # Thanks for taking the time to fill out this bug report!
+        ## Preflight Checklist
+  - type: checkboxes
+    id: preflight-checklist
+    attributes:
+      label: Preflight Checklist
+      options:
+        - label: I have read the [Contributing Guidelines](https://github.com/sbb-design-systems/lyne-angular/blob/main/docs/CONTRIBUTING.md) for this project.
+          required: true
+        - label: I agree to follow the [Code of Conduct](https://github.com/sbb-design-systems/lyne-angular/blob/main/docs/CODE_OF_CONDUCT.md) that this project adheres to.
+          required: true
+        - label: I have searched the [issue tracker](https://github.com/orgs/sbb-design-systems/projects/4) for an issue that matches the one I want to file, without success.
+          required: true
+  - type: markdown
+    attributes:
+      value: |
+        ## General Information
+  - type: dropdown
+    id: bug-type
+    attributes:
+      label: Bug type
+      options:
+        - Functionality
+        - Accessibility
+        - Performance
+        - Security vulnerability
+        - Other
+    validations:
+      required: true
+  - type: dropdown
+    id: component-or-design-token
+    attributes:
+      label: It affects the following packages
+      options:
+        - Design Tokens
+        - Components
+        - Both
+        - Other
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Which version of Lyne Components are you using
+      description: e.g. 26.2
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: |
+        ## Environment
+  - type: input
+    id: os
+    attributes:
+      label: Operating system
+      description: e.g. Windows 10
+    validations:
+      required: false
+  - type: input
+    id: browser
+    attributes:
+      label: Browser / Browser version
+      description: e.g. Mozilla Firefox 74.0 (64-bit)
+    validations:
+      required: false
+  - type: dropdown
+    id: input-mode
+    attributes:
+      label: Input mode
+      options:
+        - Mouse/Keyboard
+        - Touch
+        - Other
+    validations:
+      required: false
+  - type: input
+    id: additional-settings
+    attributes:
+      label: Additional settings
+      description: e.g. save data active
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: |
+        ## Detailed description
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+      placeholder: Tell us what you see!
+      value: |
+        Describe in detail the issue you are having.
+        What did you expect to happen? What happened instead? What would you like to see changed?
+        Is the issue related to a specific component?
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to reproduce the issue
+      description: Also tell us, what did you expect to happen?
+      placeholder: Tell us what you see!
+      value: |
+        1. Step one
+        2. Step two
+        3. ...
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+{}
diff --git a/.github/ISSUE_TEMPLATE/contributing-request.yml b/.github/ISSUE_TEMPLATE/contributing-request.yml
@@ -0,0 +1,76 @@
+name: Request for contributing
+description: Request for contributing a new component or enhancement of a component
+title: '[Contributing request]: '
+labels: 'type: contributing-request 🔨'
+assignees:
+  - octocat
+body:
+  - type: checkboxes
+    id: preflight-checklist
+    attributes:
+      label: Preflight Checklist
+      options:
+        - label: I have read the [Contributing Guidelines](https://github.com/sbb-design-systems/lyne-angular/blob/main/docs/CONTRIBUTING.md) for this project.
+          required: true
+        - label: I agree to follow the [Code of Conduct](https://github.com/sbb-design-systems/lyne-angular/blob/main/docs/CODE_OF_CONDUCT.md) that this project adheres to.
+          required: true
+        - label: I have searched the [issue tracker](https://github.com/orgs/sbb-design-systems/projects/4) for an issue that matches the one I want to file, without success.
+          required: true
+  - type: markdown
+    attributes:
+      value: |
+        ## Please describe your idea in as much detail as possible.
+  - type: dropdown
+    id: new-or-enhancement
+    attributes:
+      label: Contribution type
+      options:
+        - Contribute a new component
+        - Contribute an enhancement of a component
+    validations:
+      required: true
+  - type: dropdown
+    id: component-or-design-token
+    attributes:
+      label: It affects the following packages
+      options:
+        - Design Tokens
+        - Components
+        - 'Design Tokens & Components'
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    id: feature-description
+    attributes:
+      label: Feature Description
+      description: For what purpose is the component used? What features does it need to have? Which component should be enhanced?
+    validations:
+      required: true
+  - type: input
+    id: link
+    attributes:
+      label: Link to design proposal file
+      description: Figma-Link
+    validations:
+      required: false
+  - type: textarea
+    id: api-proposal
+    attributes:
+      label: Please describe the required properties (with type and value) for the component
+      value: |
+        Example:
+        variant (string): "primary" | "secondary" | "accent" | "transparent"
+        size (string):  "s" | "m" | "l"
+  - type: textarea
+    id: markup-proposal
+    attributes:
+      label: Please send a proposal for a html markup
+      description: This input will be automatically formatted into html.
+      render: html
+      value: |
+        Example:
+        <sbb-button>
+          <sbb-icon slot="icon" name="info"></sbb-icon>
+          Label
+        </sbb-button>
diff --git a/.github/ISSUE_TEMPLATE/feature-request-or-enhancement.yml b/.github/ISSUE_TEMPLATE/feature-request-or-enhancement.yml
@@ -0,0 +1,56 @@
+name: Feature request or enhancement
+description: Request for a new component or enhancement of a component
+title: '[Feature request]: '
+labels: ['type: feature-request 💡']
+assignees:
+  - octocat
+body:
+  - type: checkboxes
+    id: preflight-checklist
+    attributes:
+      label: Preflight Checklist
+      options:
+        - label: I have read the [Contributing Guidelines](https://github.com/sbb-design-systems/lyne-angular/blob/main/docs/CONTRIBUTING.md) for this project.
+          required: true
+        - label: I agree to follow the [Code of Conduct](https://github.com/sbb-design-systems/lyne-angular/blob/main/docs/CODE_OF_CONDUCT.md) that this project adheres to.
+          required: true
+        - label: I have searched the [issue tracker](https://github.com/orgs/sbb-design-systems/projects/4) for an issue that matches the one I want to file, without success.
+          required: true
+  - type: markdown
+    attributes:
+      value: |
+        ## Please describe your idea in as much detail as possible.
+  - type: dropdown
+    id: new-or-enhancement
+    attributes:
+      label: Request type
+      options:
+        - Request for a new component
+        - Request for enhancement of a component
+    validations:
+      required: true
+  - type: dropdown
+    id: component-or-design-token
+    attributes:
+      label: It affects the following packages
+      options:
+        - Design Tokens
+        - Components
+        - 'Design Tokens & Components'
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    id: request
+    attributes:
+      label: Functionality
+      description: For what purpose is the component used? What features does it need to have? Which component should be enhanced?
+    validations:
+      required: true
+  - type: input
+    id: link
+    attributes:
+      label: Link to design proposal file
+      description: Figma-Link
+    validations:
+      required: false
diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml
@@ -0,0 +1,52 @@
+name: Question
+description: Ask a question to our developers and user experience architects
+title: '[Question]: '
+labels: 'type: question ❓'
+assignees:
+  - octocat
+body:
+  - type: checkboxes
+    id: preflight-checklist
+    attributes:
+      label: Preflight Checklist
+      options:
+        - label: I have read the [Contributing Guidelines](https://github.com/sbb-design-systems/lyne-angular/blob/main/docs/CONTRIBUTING.md) for this project.
+          required: true
+        - label: I agree to follow the [Code of Conduct](https://github.com/sbb-design-systems/lyne-angular/blob/main/docs/CODE_OF_CONDUCT.md) that this project adheres to.
+          required: true
+        - label: I have searched the [issue tracker](https://github.com/orgs/sbb-design-systems/projects/4) for an issue that matches the one I want to file, without success.
+          required: true
+  - type: markdown
+    attributes:
+      value: |
+        ## Your question
+  - type: dropdown
+    id: component-or-design-token
+    attributes:
+      label: It affects the following packages
+      options:
+        - Design Tokens
+        - Components
+        - 'Design Tokens & Components'
+        - Other
+    validations:
+      required: true
+  - type: input
+    id: question
+    attributes:
+      label: Your Question
+    validations:
+      required: true
+  - type: textarea
+    id: relevant-information
+    attributes:
+      label: Give us a summary about your question
+    validations:
+      required: false
+  - type: textarea
+    id: additional-information
+    attributes:
+      label: Provide as much useful information as you can
+      description: e.g. Links to Figma or other references
+    validations:
+      required: false
diff --git a/.github/ISSUE_TEMPLATE/story.yml b/.github/ISSUE_TEMPLATE/story.yml
@@ -0,0 +1,30 @@
+name: '[Internal] Story'
+description: An internal story for lyne-components
+title: 'story(COMPONENT): TITLE'
+labels: [story, to-refine]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Feature Description
+      description: Provide a brief summary of the feature you would like to see.
+    validations:
+      required: true
+  - type: textarea
+    id: definition-of-done
+    attributes:
+      label: Definition of Done
+      description: |
+        What needs to be done, in order to close this issue.
+      value: |
+        - [ ] Component is implemented
+        - [ ] Documentation is provided
+        - [ ] Tests are implemented
+        - [ ] Storybook stories are implemented
+        - [ ] Navigation via keyboard is tested
+        - [ ] Screen reader output is tested
+        - [ ] High-contrast is tested
+        - [ ] Remaining accessibility is tested
+        - [ ] UX approved
+    validations:
+      required: true
diff --git a/.github/SECURITY.md b/.github/SECURITY.md
@@ -0,0 +1,22 @@
+# Security Policy
+
+⚡ **PLEASE DON'T DISCLOSE SECURITY-RELATED ISSUES PUBLICLY, [SEE BELOW](#reporting-a-vulnerability--security-issue).** ⚡
+
+## Supported Versions
+
+Only the latest major version receives security fixes.
+
+## Reporting a Vulnerability / Security Issue
+
+Let’s keep things simple –
+
+The _Lyne_ team takes all security concerns in _Lyne Design System_ seriously. Thank you for improving the security of _Lyne_. We appreciate your efforts, responsible disclosure your information and will make every effort to acknowledge your contributions.
+
+If you think you have identified a vulnerability or security related issue within _Lyne Design System_, please report it immediately to [email protected]. If you are not sure, don’t worry. Better safe than sorry – just send an email.
+
+**Please do not:**
+
+- Open issues on GitHub related to any security concerns **publicly**
+- Include **anyone else** on the disclosure email
+
+When reporting an issue, include as much information as possible — necessary. Just tell us what you found, how to reproduce it, and any concerns you have about it. We will respond as soon as possible and follow up with any missing information.