chore: update configurations (#3993)

* chore(eslint): update parser for eslint-config

* chore(prettier): add print- and tabWidth to configuration

* chore(yamllint): enhance config with indentation, trailing space, newline EOF, ignore node_modules

* chore(np-config): add branch to config

* chore(xo-config): ignore stylelint folder, remove override for svelte-showcase

* docs(readme): improve README grammar, consistency, and formatting

* docs(contributing): improve CONTRIBUTING grammar and clarity

* docs(contributing): readd direct link to opan an issue

* docs(readme): set copyright year to 2024

* chore(lint-staged): add prettier for JSON and markdown files

* chore(lint-staged): remove prettier - this is done in separated file

* docs(pr-template): update wording

* docs(bug-template): improve grammar and wording

* chore(adr): move icons adr to adr-folder

* docs: improve docs wording for clarity and consistency

* chore(labeler): add configuration label for .config folder changes

* Update package.json

Co-authored-by: Maximilian Franzke <[email protected]>

* chore: update from main

* chore: run fmt

* chore: run fmt

---------

Co-authored-by: Nicolas Merget <[email protected]>
Co-authored-by: Maximilian Franzke <[email protected]>
Co-authored-by: Nicolas Merget <[email protected]>

Author: 3 people

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -7,12 +7,12 @@ body:
   - type: markdown
     attributes:
       value: |
-        Thanks for taking the time to fill out this bug report! Feedback by the community has a very high value for us, to improve our work and to have every other user benefit from it as well. 🙂
+        Thank you for taking the time to fill out this bug report! Feedback from the community is highly valuable to us, as it helps improve our work and benefits all users. 🙂
 
   - type: checkboxes
     id: component
     attributes:
-      label: Which generators are impacted?
+      label: Which generators are affected?
       description: Select all the ones that apply, to the best of your knowledge.
       options:
         - label: All
@@ -51,7 +51,7 @@ body:
       required: false
     attributes:
       label: Browser version
-      description: Does this bug affect specific browser?
+      description: Does this bug affect a specific browser?
       options:
         - Chrome
         - Safari

.github/PULL_REQUEST_TEMPLATE.md

@@ -7,9 +7,9 @@
 <!-- What types of changes does your code introduce?
 _Put an `x` in the boxes that apply_ -->
 
-- [ ] Bugfix (non-breaking change which fixes an issue)
+- [ ] Bugfix (non-breaking change that fixes an issue)
 - [ ] New feature (non-breaking change which adds functionality)
-- [ ] Refactoring (fix on existing components or architectural decisions)
+- [ ] Refactoring (improvements to 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)
 

.github/labeler.yml

@@ -23,3 +23,8 @@
 📺showcases:
   - changed-files:
       - any-glob-to-any-file: "showcases/**"
+
+# Add 'configuration' label to any file changes for configuration files
+🛠️configuration:
+  - changed-files:
+      - any-glob-to-any-file: ".config/**"

.np-config.json

@@ -1,4 +1,5 @@
 {
 	"yarn": false,
-	"publish": false
+	"publish": false,
+	"branch": "main"
 }

.yamllint.yml

@@ -10,7 +10,16 @@ rules:
     allow-non-breakable-inline-mappings: true
   document-start:
     present: false
+  document-end:
+    present: false
   comments:
     min-spaces-from-content: 1
+  indentation:
+    spaces: 2
+  trailing-spaces:
+    level: error
+  new-line-at-end-of-file:
+    present: true
 ignore: |
   .git/
+  node_modules/

CONTRIBUTING.md

@@ -1,8 +1,8 @@
 # Contributing
 
-Thanks for your interest in our project. Contributions are welcome. Feel free to [open an issue](https://github.com/db-ux-design-system/core-web/issues/new) with questions or reporting ideas and bugs, or [open pull requests](https://github.com/db-ux-design-system/core-web/compare) to contribute code.
+**Thank you for your interest in our project.** Contributions are always welcome. **Feel free to [open an issue](https://github.com/db-ux-design-system/core-web/issues/new) if you have any questions, ideas, or bugs to report, or submit pull requests to contribute code.**
 
-We are committed to fostering a welcoming, respectful, and harassment-free environment. Be kind!
+We are committed to fostering a welcoming, respectful, and harassment-free environment, **so please be kind! 💖**
 
 ## Prepare
 
@@ -28,12 +28,12 @@ npm run dev
 
 ## Make changes / Before you commit
 
-Please make sure that husky is installed correctly to validate your changes.
+Please ensure that **Husky** is installed correctly to validate your changes.
 
 Please verify you are using a valid branch name as described by the pattern in your [`package.json`](./package.json) in the section `validate-branch-name`.
 
 Moreover, you need to duplicate [`.env.template`](./.env.template) as [`.env`](./.env) and type your own email address. This ensures that you have the correct email set for this project.
 
 ### Conventions
 
-Please be aware that we have some [code and git commit (message and branch naming) conventions](docs/conventions.md), that we ensure with some linting tools.
+Please note that we have established [code and git commit (message and branch naming) conventions](docs/conventions.md), which are enforced using various linting tools.

README.md

@@ -14,7 +14,7 @@
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](CODE-OF-CONDUCT.md)
 
 DB UX Design System v3 provides robust HTML UI components, reusable visual styles, and powerful tooling to help developers,
-designers, and content authors build, maintain, and scale best of class digital experiences.
+designers, and content authors build, maintain, and scale best-of-class digital experiences.
 
 <figure>
 	<cite>We’re not designing pages anymore. We’re designing systems of components.</cite>
@@ -36,8 +36,8 @@ designers, and content authors build, maintain, and scale best of class digital
 
 Install your preferred package via npm or yarn e.g. `npm i @db-ux/react-core-components`.
 
-Afterwards you need to add the specific CSS or SCSS files to provide the styles of DB UX Design System (Version 3), as described in the "Styling Dependencies" of each packages `README`.
-We even also provide some [examples of integrations](https://github.com/db-ux-design-system/examples).
+Afterwards, you need to include the specific CSS or SCSS files to apply the styles of DB UX Design System (Version 3), as described in the "Styling Dependencies" section of each package's `README`.
+We even provide some [examples of integrations](https://github.com/db-ux-design-system/examples).
 
 ### DB Theme
 
@@ -47,7 +47,7 @@ In case that you're building a website or application for Deutsche Bahn, you'll
 
 We maintain a [status overview](https://github.com/orgs/db-ux-design-system/projects/4/views/1) for all components.
 
-## Core principals
+## Core principles
 
 <details>
   <summary><strong>
@@ -117,7 +117,7 @@ This is mainly a platform providing the space and technology for a common basis
 is mainly driven by the community and adapted out of the work done in projects and through the huge amount of feedback
 that we're gaining out of the community. So please support us in any way possible, this is greatly appreciated!
 
-## How to start develop / contribute
+## How to start developing / contributing
 
 If you're working as a developer on the DB UX Design System or would like to contribute (many kudos for that !), please have a look at the relevant [development documentation](docs/development.md). We even also tag issues that might be a good starter for code contributions by the [tag "good first issue"](https://github.com/db-ux-design-system/core-web/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22).
 
@@ -137,12 +137,12 @@ We're particularly keen to add as many examples to the behaviours as possible, t
 
 ## Deutsche Bahn brand
 
-As we'd like to perfectly support our users and customers on their digital journey, the usage of Deutsche Bahn brand and
-trademarks are bound to clear guidelines and restrictions even when being used with the code that we're providing with
-this product; Deutsche Bahn fully reserves all rights and ownership regarding the Deutsche Bahn brand, even though that
-we're providing the code of DB UX Design System products free to use and release it under the Apache 2.0 license.
-Please have a look at our brand portal at <https://marketingportal.extranet.deutschebahn.com/> for any further questions
-and whom to contact on any brand issues. As these assets and visual guidelines are retrieved from our Deutsche Bahn
+To perfectly support our users and customers on their digital journey, the use of the Deutsche Bahn brand and trademarks is subject
+to clear guidelines and restrictions even when used with the code provided by this product. Deutsche Bahn fully reserves all
+rights and ownership regarding the Deutsche Bahn brand, even though we provide the code for DB UX Design System products free of
+charge under the Apache 2.0 license.
+Please refer to our brand portal at <https://marketingportal.extranet.deutschebahn.com/> for further questions
+contact details regarding brand issues. As these assets and visual guidelines are retrieved from our Deutsche Bahn
 Marketingportal, you'll agree with
 the ["Allgemeine Nutzungsbedingungen für das DB-Marketingportal" (german)](https://marketingportal.extranet.deutschebahn.com/marketingportal/Nutzungsbedingungen-9702684#)
 in case of using them.
@@ -162,4 +162,4 @@ our [Contributor Covenant Code of Conduct](https://github.com/db-ux-design-syste
 
 ## License
 
-This project is licensed under [Apache-2.0](LICENSE), Copyright 2024 by DB Systel GmbH.
+This project is licensed under the [Apache-2.0](LICENSE) license. © 2024 DB Systel GmbH.

docs/adr-04-icons.md renamed to docs/adr/adr-04-icons.md

@@ -50,6 +50,8 @@ The [xo](https://github.com/db-ui/core/blob/main/docs/adr/linting-xo.adoc) tool
 
 - [yamllint.readthedocs.io](https://yamllint.readthedocs.io/)
 
+The [prettier](https://github.com/db-ui/core/blob/main/docs/adr/code_style_formatter-prettier.adoc) tool provides a general code prettifying.
+
 ### markdown files via markdownlint
 
 - [github.com/markdownlint/markdownlint](https://github.com/markdownlint/markdownlint/)

docs/conventions.md

@@ -2,5 +2,5 @@
 
 ## General
 
-- Depending on necessary code changes for consuming packages you'll probably need to add a new file or add entries to the next release within [`/docs/migration`](https://github.com/db-ux-design-system/core-web/tree/main/docs/migration) folder.
-- Please have a final lookup of all of your changes e.g. within the "Files changed" tab of the PR within GitHub. This final check could lead to some findings on outstanding work, missing TODOs, `console.log` leftovers or whatever.
+- Depending on the necessary code changes for consuming packages, you may need to add a new file or include entries for the next release in the [`/docs/migration`](https://github.com/db-ux-design-system/core-web/tree/main/docs/migration) folder.
+- Please perform a final lookup of all of your changes, for example by checking the "Files changed" tab of your pull request on GitHub. This final review might lead to some findings on outstanding work, missing TODOs, `console.log` leftovers or other issues.