Skip to content

chore: update configurations #3993

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 17 commits into
base: main
Choose a base branch
from
Draft

Conversation

michaelmkraus
Copy link
Contributor

@michaelmkraus michaelmkraus commented Apr 1, 2025

Proposed changes

This pull request introduces several configuration improvements across the project. The following commits have been applied:

  1. chore(np-config): add branch, tag, and commit options
  • Adds essential options to control the release process via np (specifying the branch).
  1. chore(yamllint): enhance config with 2-space indentation, trailing space check, newline at EOF, and ignore node_modules
  • Updates the yamllint configuration to enforce consistent formatting by setting a 2-space indentation, checking for trailing spaces and enforcing a newline at the end of files.
  • Excludes additional directories (e.g., node_modules) from linting.
  1. chore(prettier): refine trailing comma settings, tabWidth, etc.
  • Refines the Prettier configuration by adjusting trailing comma settings and other formatting options (e.g., setting tabWidth) to ensure code consistency.
  1. chore(eslint): update parser and set strict mode
  • Updates the ESLint parser (switching to @babel/eslint-parser) and enables stricter settings (e.g., "strict": true) to improve overall code quality.
  1. chore(xo-config): add documentation for overrides
  • Enhances the XO configuration by adding documentation and clarifications for the specific rule overrides, making it easier for team members to understand why certain rules are disabled for particular files or directories.
  1. docs(contributing): improve CONTRIBUTING grammar and clarity
  • Enhances the CONTRIBUTING.md file by refining grammar and overall clarity, making it easier for new contributors to understand the guidelines.
  1. docs(readme): improve README grammar, consistency, and formatting
  • Updates the README.md with more consistent grammar and formatting to ensure a clearer overview of the project’s packages, usage instructions, and community guidelines.
  1. chore(lint-staged): add prettier for json and markdown files
  • Enhances the lint-staged configuration by adding Prettier commands for JSON and Markdown files, ensuring that these file types are consistently formatted before each commit.
  1. docs(pr-template): update wording
  • Updates the pull request template to improve wording.
  1. docs(bug-template): improve grammar and wording
  • Refines the bug report template by making grammar and wording improvements.
  1. docs(adr): move icons adr to adr-folder
  • Move icons adr to adr-folder
  1. docs: improve docs wording for clarity and consistency
  • Improving grammatical consistency and clarity in the docs section.
  1. chore(labeler): add configuration label for .config folder changes
  • Enhanced the labeler to automatically assign the configuration label to changes within .config folder.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (fix on existing components or architectural decisions)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)

Copy link
Contributor

github-actions bot commented Apr 1, 2025

@michaelmkraus michaelmkraus moved this to Backlog JIRA in UX Engineering Team Backlog Apr 1, 2025
@michaelmkraus michaelmkraus moved this from Backlog JIRA to 📋 Backlog in UX Engineering Team Backlog Apr 1, 2025
@michaelmkraus michaelmkraus moved this from 📋 Backlog to Backlog JIRA in UX Engineering Team Backlog Apr 1, 2025
@mfranzke mfranzke changed the title Chore update configurations chore: update configurations Apr 1, 2025
@michaelmkraus michaelmkraus moved this from Backlog JIRA to 👀 In review in UX Engineering Team Backlog Apr 1, 2025
@michaelmkraus michaelmkraus added the 📕documentation Improvements or additions to documentation label Apr 1, 2025
@@ -1,6 +1,8 @@
{
"trailingComma": "none",
"bracketSpacing": true,
"printWidth": 150,
"tabWidth": 2,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"tabWidth": 2 is even already the default for prettier, why do you set this again ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Explicitly setting tabWidth: 2 ensures clear documentation for all contributors, even if it’s the default. If we do not want this, I will remove it.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"tabWidth": 2,

Even though that it seems to be a good intention, I'm struggling to start with doing this, as we would probably have to set further default aspects for consistency.

Comment on lines 2 to +3
prettier: true,
ignores: [
'./showcases/nuxt-showcase/**',
'./packages/migration/**',
'./packages/foundations/**'
],
ignores: ['./showcases/nuxt-showcase/**', './packages/migration/**', './packages/stylelint/**', './packages/foundations/**'],
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why should we ignore the stylelint-plugin-package in total ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought the linting is only meant for the component-package and the stylelint-package was forgotten to be ignored.

Copy link
Collaborator

@mfranzke mfranzke May 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
prettier: true,
ignores: [
'./showcases/nuxt-showcase/**',
'./packages/migration/**',
'./packages/foundations/**'
],
ignores: ['./showcases/nuxt-showcase/**', './packages/migration/**', './packages/stylelint/**', './packages/foundations/**'],
ignores: [
'./showcases/nuxt-showcase/**',
'./packages/migration/**',
'./packages/foundations/**'
],

let's revert it.

@github-actions github-actions bot added the 🚢📀cicd Changes inside .github folder label Apr 1, 2025
@mfranzke mfranzke moved this from 👀 In review to 🏗 In development in UX Engineering Team Backlog Apr 17, 2025
@@ -11,7 +11,7 @@
"bugs": {
"url": "https://github.com/db-ux-design-system/core-web/issues"
},
"author": "",
"author": "Deutsche Bahn AG",
Copy link
Collaborator

@mfranzke mfranzke May 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"author": "Deutsche Bahn AG",
"author": "DB Systel GmbH",

aligned with our copyright entry.

@mfranzke
Copy link
Collaborator

@michaelmkraus I added some comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🚢📀cicd Changes inside .github folder 🛠️configuration 📕documentation Improvements or additions to documentation
Projects
Status: 🏗 In development
Development

Successfully merging this pull request may close these issues.

2 participants