From 70d2f97736caea5120a72569e88e6110cdaa55c1 Mon Sep 17 00:00:00 2001 From: Haytham Salama Date: Sat, 23 Sep 2023 04:39:01 +0300 Subject: [PATCH 01/14] docs: add contributing page --- .../1.getting-started/6.contributing.md | 116 ++++++++++++++++++ .../{6.roadmap.md => 7.roadmap.md} | 0 2 files changed, 116 insertions(+) create mode 100644 docs/content/1.getting-started/6.contributing.md rename docs/content/1.getting-started/{6.roadmap.md => 7.roadmap.md} (100%) diff --git a/docs/content/1.getting-started/6.contributing.md b/docs/content/1.getting-started/6.contributing.md new file mode 100644 index 0000000000..0417ea9d8a --- /dev/null +++ b/docs/content/1.getting-started/6.contributing.md @@ -0,0 +1,116 @@ +--- +title: Contributing +description: Learn how to contributing to Nuxt UI +--- + +## Overview + +Nuxt UI thrives thanks to its fantastic community, which contributes by submitting issues, creating pull requests, and offering valuable feedback. + +## Reporting Bugs + +Before opening an issue to report a bug, please check our guide for some important steps. + +## Feature Requests + +Before opening an issue for a feature request, please review our guide for essential considerations. + +## Submitting a Pull Request + +### 1. Before You Start + +- Check if there's an existing issue describing the problem or feature request. +- For feature development, open a feature request issue for discussion. +- Bundle typo fixes in a single pull request. + +### 2. Local Development + +1. Clone the `nuxt/ui` repository to your local machine: + +```sh +git clone https://github.com/nuxt/ui.git +``` + +2. Install dependencies and start the development environment server: + +```sh +pnpm install +npm run dev:prepare +npm run dev +``` + +#### IDE Setup + +We recommend using VS Code along with the ESLint extension. You can enable auto-fix and formatting when saving your code. Here's how: + +```json +{ + "editor.codeActionsOnSave": { + "source.fixAll": false, + "source.fixAll.eslint": true + } +} +``` + +You can also use the `lint` command: + +```sh +npm run lint +npm run lint:fix +``` + +#### No Prettier + +Since ESLint is already configured to format the code, there's no need for duplicating functionality with Prettier. + +If you have Prettier installed in your editor, we recommend disabling it to avoid conflicts. Note that we are discussing enabling Prettier in the future. + +### 3. Commit Conventions + +Use Conventional Commits for commit messages with the following format: + +``` +{type}({scope - optional}): {subject} + +{body} + +{footer} +``` + +#### `{types}` + +- `feat`: for new features +- `fix`: for bug fixes +- `refactor`: for code changes that are neither bug fixes nor new features +- `perf`: for code refactoring that improves performance +- `test`: for code related to automatic testing +- `style`: for refactoring related to code style (not for CSS) +- `docs`: for changes related to readme or documentation-only changes +- `chore`: for anything else + +#### `{scope}` + +Where the change occurred, e.g., the component (`Table`, `Button`). + +#### `{subject}` + +A summary of the changes made. + +#### Examples + +``` +feat(Alert): new component +chore(Table): improve accessibility +``` + +### 4. Making the Pull Request + +- Follow the guide for creating a pull request and ensure your PR's title adheres to the Commit Convention. Mention any related issues in the PR description. + +- Multiple commits are fine; no need to rebase or force push. We'll use `Squash and Merge` when merging. + +- Ensure linting and make tests before making a PR. Avoid unrelated changes. + +### 5. After You've Made a Pull Request + +We'll review it promptly. If assigned to a maintainer, they'll review it carefully. Ignore the red text; it's for tracking purposes. diff --git a/docs/content/1.getting-started/6.roadmap.md b/docs/content/1.getting-started/7.roadmap.md similarity index 100% rename from docs/content/1.getting-started/6.roadmap.md rename to docs/content/1.getting-started/7.roadmap.md From 94d3ac392015872594f5a7c0e05e7db9d173927c Mon Sep 17 00:00:00 2001 From: Haytham Salama Date: Sat, 23 Sep 2023 19:49:41 +0300 Subject: [PATCH 02/14] up --- .../1.getting-started/6.contributing.md | 86 +++++++++++++++---- 1 file changed, 69 insertions(+), 17 deletions(-) diff --git a/docs/content/1.getting-started/6.contributing.md b/docs/content/1.getting-started/6.contributing.md index 0417ea9d8a..0ec6aa2eca 100644 --- a/docs/content/1.getting-started/6.contributing.md +++ b/docs/content/1.getting-started/6.contributing.md @@ -5,15 +5,16 @@ description: Learn how to contributing to Nuxt UI ## Overview -Nuxt UI thrives thanks to its fantastic community, which contributes by submitting issues, creating pull requests, and offering valuable feedback. +Nuxt UI thrives thanks to its fantastic community ❤️, which contributes by submitting issues, creating pull requests, and offering valuable feedback. + ## Reporting Bugs -Before opening an issue to report a bug, please check our guide for some important steps. +Before reporting a bug, please make sure that you have read through our documentation and existing [issues](https://github.com/nuxt/ui/issues). ## Feature Requests -Before opening an issue for a feature request, please review our guide for essential considerations. +Before requesting a feature, please make sure that you have read through our documentation and existing [issues](https://github.com/nuxt/ui/issues). ## Submitting a Pull Request @@ -70,29 +71,29 @@ If you have Prettier installed in your editor, we recommend disabling it to avoi Use Conventional Commits for commit messages with the following format: ``` -{type}({scope - optional}): {subject} +(optional scope): -{body} +[optional body] -{footer} +[optional footer(s)] ``` -#### `{types}` +#### Types -- `feat`: for new features -- `fix`: for bug fixes -- `refactor`: for code changes that are neither bug fixes nor new features -- `perf`: for code refactoring that improves performance -- `test`: for code related to automatic testing -- `style`: for refactoring related to code style (not for CSS) -- `docs`: for changes related to readme or documentation-only changes -- `chore`: for anything else +- `feat` : for new features +- `fix` : for bug fixes +- `refactor` : for code changes that are neither bug fixes nor new features +- `perf` : for code refactoring that improves performance +- `test` : for code related to automatic testing +- `style` : for refactoring related to code style (not for CSS) +- `docs` : for changes related to readme or documentation-only changes +- `chore` : for anything else -#### `{scope}` +#### Scope Where the change occurred, e.g., the component (`Table`, `Button`). -#### `{subject}` +#### description A summary of the changes made. @@ -101,6 +102,7 @@ A summary of the changes made. ``` feat(Alert): new component chore(Table): improve accessibility +docs: migrate to @nuxt/ui-pro ``` ### 4. Making the Pull Request @@ -114,3 +116,53 @@ chore(Table): improve accessibility ### 5. After You've Made a Pull Request We'll review it promptly. If assigned to a maintainer, they'll review it carefully. Ignore the red text; it's for tracking purposes. + +## Project Structure + +There are main folders : + +- **Documentation - `docs`** : This is a Nuxt Project that is separate. + +``` +docs/ +├── components/ +│ ├── examples/ # Components used in documentation as examples +│ └── themes/ # Components used in the examples page in the theming section +├── content/ # Documentation, separated into categories according to component types +│ ├── 1.getting-started/ +│ │ ├── 1.accordion.md # Docs for a single component (i.e., accordion) +│ │ ├── 2.alert.md +│ │ ├── ... etc +│ ├── 2.elements/ # The category of components, which are elements +│ │ ├── 1.accordion.md # Docs for a single component (i.e., accordion) +│ │ ├── 2.alert.md +│ │ ├── ... etc +└── ... etc +``` + +- **Components - `src`** : + +``` +src/ +├── runtime/ +│ ├── composables/ # Composable functions used in components +│ ├── components/ # Components folder, separated into categories according to component types +│ │ ├── data/ # The category of components, which are data-related +│ │ │ ├── table.vue/ # Table component +│ │ │ ├── elements/ # Elements category +│ │ │ │ ├── ...etc/ # Other elements components +│ │ │ └── ... etc/ # Other data components +│ │ ├── plugins/ # Plugins used in components +│ │ ├── utils/ # Utility functions used on the components page (e.g., lodash) +│ │ ├── types/ # Types used in components +│ │ │ ├── accordion.d.ts/ # [componentName].d.ts type used in a single component +│ │ │ ├── avatar.d.ts/ # Types for the avatar component +│ │ │ └── ... etc/ # Other component types +│ │ ├── ui.config.ts/ # Configuration file used to apply styles to every component +├── colors.ts/ # Everything related to color functions (e.g., safelistByComponent, generateSafelist) +└── ... etc/ # Other files and folders +``` + +## Thanks + +Thank you again for being interested in this project! You are awesome! ❤️ From 3342f5d33ed545ec6b1328420a7f5401b132755f Mon Sep 17 00:00:00 2001 From: Haytham Salama Date: Sat, 23 Sep 2023 19:55:50 +0300 Subject: [PATCH 03/14] up --- docs/content/1.getting-started/6.contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/1.getting-started/6.contributing.md b/docs/content/1.getting-started/6.contributing.md index 0ec6aa2eca..13a9be57c2 100644 --- a/docs/content/1.getting-started/6.contributing.md +++ b/docs/content/1.getting-started/6.contributing.md @@ -1,6 +1,6 @@ --- title: Contributing -description: Learn how to contributing to Nuxt UI +description: Learn how to contribute to Nuxt UI. --- ## Overview @@ -64,7 +64,7 @@ npm run lint:fix Since ESLint is already configured to format the code, there's no need for duplicating functionality with Prettier. -If you have Prettier installed in your editor, we recommend disabling it to avoid conflicts. Note that we are discussing enabling Prettier in the future. +If you have Prettier installed in your editor, we recommend disabling it to avoid conflicts. ### 3. Commit Conventions From 273ed3a3d8ef83f30c65068f4b789368cf8621bf Mon Sep 17 00:00:00 2001 From: Haytham Salama Date: Sat, 23 Sep 2023 19:58:02 +0300 Subject: [PATCH 04/14] up --- docs/content/1.getting-started/6.contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/1.getting-started/6.contributing.md b/docs/content/1.getting-started/6.contributing.md index 13a9be57c2..17ed674d6d 100644 --- a/docs/content/1.getting-started/6.contributing.md +++ b/docs/content/1.getting-started/6.contributing.md @@ -56,8 +56,8 @@ We recommend using VS Code along with the ESLint extension. You can enable auto- You can also use the `lint` command: ```sh -npm run lint -npm run lint:fix +npm run lint # check for linting errors +npm run lint:fix # fix linting errors ``` #### No Prettier From 91d33af7de652bb175551412d333d55389dea804 Mon Sep 17 00:00:00 2001 From: Haytham Salama Date: Sat, 23 Sep 2023 20:00:39 +0300 Subject: [PATCH 05/14] up --- .../1.getting-started/6.contributing.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/content/1.getting-started/6.contributing.md b/docs/content/1.getting-started/6.contributing.md index 17ed674d6d..21c4fff513 100644 --- a/docs/content/1.getting-started/6.contributing.md +++ b/docs/content/1.getting-started/6.contributing.md @@ -80,20 +80,20 @@ Use Conventional Commits for commit messages with the following format: #### Types -- `feat` : for new features -- `fix` : for bug fixes -- `refactor` : for code changes that are neither bug fixes nor new features -- `perf` : for code refactoring that improves performance -- `test` : for code related to automatic testing -- `style` : for refactoring related to code style (not for CSS) -- `docs` : for changes related to readme or documentation-only changes -- `chore` : for anything else +- `feat` : for new features. +- `fix` : for bug fixes. +- `refactor` : for code changes that are neither bug fixes nor new features. +- `perf` : for code refactoring that improves performance. +- `test` : for code related to automatic testing. +- `style` : for refactoring related to code style (not for CSS). +- `docs` : for changes related to documentation. +- `chore` : for anything else. #### Scope Where the change occurred, e.g., the component (`Table`, `Button`). -#### description +#### Description A summary of the changes made. From 4ed3f68c5c93fb93d90734761f09c1ceea08cd72 Mon Sep 17 00:00:00 2001 From: Haytham Salama Date: Sat, 23 Sep 2023 20:05:31 +0300 Subject: [PATCH 06/14] up --- docs/content/1.getting-started/6.contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/1.getting-started/6.contributing.md b/docs/content/1.getting-started/6.contributing.md index 21c4fff513..2a93e7b173 100644 --- a/docs/content/1.getting-started/6.contributing.md +++ b/docs/content/1.getting-started/6.contributing.md @@ -91,7 +91,7 @@ Use Conventional Commits for commit messages with the following format: #### Scope -Where the change occurred, e.g., the component (`Table`, `Button`). +Where the change occurred (e.g., `Table`, `Alert`, `Accordion`, etc.). #### Description @@ -111,7 +111,7 @@ docs: migrate to @nuxt/ui-pro - Multiple commits are fine; no need to rebase or force push. We'll use `Squash and Merge` when merging. -- Ensure linting and make tests before making a PR. Avoid unrelated changes. +- Ensure linting and make tests manually before submitting the PR. Avoid making unrelated changes. ### 5. After You've Made a Pull Request From 7f6b00e4f85fd075fc3acdc650bf1261612f18ab Mon Sep 17 00:00:00 2001 From: Haytham Salama Date: Sat, 23 Sep 2023 20:11:47 +0300 Subject: [PATCH 07/14] up --- docs/content/1.getting-started/6.contributing.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/content/1.getting-started/6.contributing.md b/docs/content/1.getting-started/6.contributing.md index 2a93e7b173..3942bf8ca6 100644 --- a/docs/content/1.getting-started/6.contributing.md +++ b/docs/content/1.getting-started/6.contributing.md @@ -20,9 +20,9 @@ Before requesting a feature, please make sure that you have read through our doc ### 1. Before You Start -- Check if there's an existing issue describing the problem or feature request. -- For feature development, open a feature request issue for discussion. -- Bundle typo fixes in a single pull request. +Check if there's an existing issue describing the problem or feature request you're working on. If there is, please leave a comment on the issue to let us know you're working on it. + +If there isn't, open a new issue to discuss the problem or feature. ### 2. Local Development From ddd10a3ea33744179063592a684baa2ff13b46f3 Mon Sep 17 00:00:00 2001 From: Haytham Salama Date: Mon, 25 Sep 2023 01:21:42 +0300 Subject: [PATCH 08/14] up --- .../1.getting-started/6.contributing.md | 35 ++++++++++++++----- 1 file changed, 27 insertions(+), 8 deletions(-) diff --git a/docs/content/1.getting-started/6.contributing.md b/docs/content/1.getting-started/6.contributing.md index 3942bf8ca6..5ab1aa4da0 100644 --- a/docs/content/1.getting-started/6.contributing.md +++ b/docs/content/1.getting-started/6.contributing.md @@ -24,7 +24,9 @@ Check if there's an existing issue describing the problem or feature request you If there isn't, open a new issue to discuss the problem or feature. -### 2. Local Development +### 2. Local Development Setup + +To begin local development, follow these steps: 1. Clone the `nuxt/ui` repository to your local machine: @@ -32,12 +34,25 @@ If there isn't, open a new issue to discuss the problem or feature. git clone https://github.com/nuxt/ui.git ``` -2. Install dependencies and start the development environment server: +2. Install dependencies and prepare the project: ```sh pnpm install -npm run dev:prepare -npm run dev +pnpm run dev:prepare +``` + +3. To configure your local development environment, use the following commands: + +- To work on the **documentation** in the `docs` folder, run: + +```sh +pnpm run dev:docs +``` + +- To test the components located in the `playground` folder within `app.vue`, run: + +```sh +pnpm run dev:play ``` #### IDE Setup @@ -56,8 +71,8 @@ We recommend using VS Code along with the ESLint extension. You can enable auto- You can also use the `lint` command: ```sh -npm run lint # check for linting errors -npm run lint:fix # fix linting errors +pnpm run lint # check for linting errors +pnpm run lint:fix # fix linting errors ``` #### No Prettier @@ -119,9 +134,11 @@ We'll review it promptly. If assigned to a maintainer, they'll review it careful ## Project Structure -There are main folders : +In this project, you'll find a variety of folders and files that serve different purposes. Here's an overview of the main ones: + +- **Documentation - `docs`** : -- **Documentation - `docs`** : This is a Nuxt Project that is separate. +The documentation is located in the `docs` folder. It's a Nuxt app that uses the `@nuxt/content` module to generate the documentation pages from Markdown files. Here's a breakdown of its structure: ``` docs/ @@ -142,6 +159,8 @@ docs/ - **Components - `src`** : +The components are located in the `src` folder. It's separated into categories according to component types. Here's a breakdown of its structure: + ``` src/ ├── runtime/ From 4901d698a2f49b51ac29a648f24c18e4497cf993 Mon Sep 17 00:00:00 2001 From: Haytham Salama Date: Mon, 25 Sep 2023 01:23:14 +0300 Subject: [PATCH 09/14] up --- docs/content/1.getting-started/6.contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/1.getting-started/6.contributing.md b/docs/content/1.getting-started/6.contributing.md index 5ab1aa4da0..299c35c15f 100644 --- a/docs/content/1.getting-started/6.contributing.md +++ b/docs/content/1.getting-started/6.contributing.md @@ -46,7 +46,7 @@ pnpm run dev:prepare - To work on the **documentation** in the `docs` folder, run: ```sh -pnpm run dev:docs +pnpm run dev ``` - To test the components located in the `playground` folder within `app.vue`, run: From 6ddba0f7a358c3c4f1c673c67004da0adaff365c Mon Sep 17 00:00:00 2001 From: Haytham Salama Date: Mon, 25 Sep 2023 01:29:42 +0300 Subject: [PATCH 10/14] up --- docs/content/1.getting-started/6.contributing.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/content/1.getting-started/6.contributing.md b/docs/content/1.getting-started/6.contributing.md index 299c35c15f..1cdad74293 100644 --- a/docs/content/1.getting-started/6.contributing.md +++ b/docs/content/1.getting-started/6.contributing.md @@ -146,9 +146,9 @@ docs/ │ ├── examples/ # Components used in documentation as examples │ └── themes/ # Components used in the examples page in the theming section ├── content/ # Documentation, separated into categories according to component types -│ ├── 1.getting-started/ -│ │ ├── 1.accordion.md # Docs for a single component (i.e., accordion) -│ │ ├── 2.alert.md +│ ├── 1.getting-started/ +│ │ ├── 1.index.md +│ │ ├── 2.installation.md │ │ ├── ... etc │ ├── 2.elements/ # The category of components, which are elements │ │ ├── 1.accordion.md # Docs for a single component (i.e., accordion) From 7442b85706da5434c1e7668aad7556d1da466c87 Mon Sep 17 00:00:00 2001 From: Haytham Salama Date: Mon, 25 Sep 2023 01:32:40 +0300 Subject: [PATCH 11/14] up --- docs/content/1.getting-started/6.contributing.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/content/1.getting-started/6.contributing.md b/docs/content/1.getting-started/6.contributing.md index 1cdad74293..bfd6d31a16 100644 --- a/docs/content/1.getting-started/6.contributing.md +++ b/docs/content/1.getting-started/6.contributing.md @@ -166,17 +166,17 @@ src/ ├── runtime/ │ ├── composables/ # Composable functions used in components │ ├── components/ # Components folder, separated into categories according to component types -│ │ ├── data/ # The category of components, which are data-related +│ │ ├── data/ # The category of components, which are data related │ │ │ ├── table.vue/ # Table component │ │ │ ├── elements/ # Elements category -│ │ │ │ ├── ...etc/ # Other elements components -│ │ │ └── ... etc/ # Other data components +│ │ │ │ ├── ...etc/ +│ │ │ └── ... etc/ │ │ ├── plugins/ # Plugins used in components │ │ ├── utils/ # Utility functions used on the components page (e.g., lodash) │ │ ├── types/ # Types used in components -│ │ │ ├── accordion.d.ts/ # [componentName].d.ts type used in a single component -│ │ │ ├── avatar.d.ts/ # Types for the avatar component -│ │ │ └── ... etc/ # Other component types +│ │ │ ├── accordion.d.ts/ # [componentName].d.ts type used for single component +│ │ │ ├── avatar.d.ts/ +│ │ │ └── ... etc/ │ │ ├── ui.config.ts/ # Configuration file used to apply styles to every component ├── colors.ts/ # Everything related to color functions (e.g., safelistByComponent, generateSafelist) └── ... etc/ # Other files and folders From c13aa9db5b984219923e4b4e784d09139c9d8e97 Mon Sep 17 00:00:00 2001 From: Benjamin Canac Date: Thu, 28 Sep 2023 15:13:06 +0200 Subject: [PATCH 12/14] up --- .../1.getting-started/6.contributing.md | 25 +++++++------------ 1 file changed, 9 insertions(+), 16 deletions(-) diff --git a/docs/content/1.getting-started/6.contributing.md b/docs/content/1.getting-started/6.contributing.md index bfd6d31a16..bdaa8e56ea 100644 --- a/docs/content/1.getting-started/6.contributing.md +++ b/docs/content/1.getting-started/6.contributing.md @@ -3,18 +3,11 @@ title: Contributing description: Learn how to contribute to Nuxt UI. --- -## Overview +## Overview Nuxt UI thrives thanks to its fantastic community ❤️, which contributes by submitting issues, creating pull requests, and offering valuable feedback. - -## Reporting Bugs - -Before reporting a bug, please make sure that you have read through our documentation and existing [issues](https://github.com/nuxt/ui/issues). - -## Feature Requests - -Before requesting a feature, please make sure that you have read through our documentation and existing [issues](https://github.com/nuxt/ui/issues). +Before reporting a bug or reporting a feature, please make sure that you have read through our documentation and existing [issues](https://github.com/nuxt/ui/issues). ## Submitting a Pull Request @@ -136,7 +129,7 @@ We'll review it promptly. If assigned to a maintainer, they'll review it careful In this project, you'll find a variety of folders and files that serve different purposes. Here's an overview of the main ones: -- **Documentation - `docs`** : +- **Documentation - `docs`** : The documentation is located in the `docs` folder. It's a Nuxt app that uses the `@nuxt/content` module to generate the documentation pages from Markdown files. Here's a breakdown of its structure: @@ -146,8 +139,8 @@ docs/ │ ├── examples/ # Components used in documentation as examples │ └── themes/ # Components used in the examples page in the theming section ├── content/ # Documentation, separated into categories according to component types -│ ├── 1.getting-started/ -│ │ ├── 1.index.md +│ ├── 1.getting-started/ +│ │ ├── 1.index.md │ │ ├── 2.installation.md │ │ ├── ... etc │ ├── 2.elements/ # The category of components, which are elements @@ -169,14 +162,14 @@ src/ │ │ ├── data/ # The category of components, which are data related │ │ │ ├── table.vue/ # Table component │ │ │ ├── elements/ # Elements category -│ │ │ │ ├── ...etc/ -│ │ │ └── ... etc/ +│ │ │ │ ├── ...etc/ +│ │ │ └── ... etc/ │ │ ├── plugins/ # Plugins used in components │ │ ├── utils/ # Utility functions used on the components page (e.g., lodash) │ │ ├── types/ # Types used in components │ │ │ ├── accordion.d.ts/ # [componentName].d.ts type used for single component -│ │ │ ├── avatar.d.ts/ -│ │ │ └── ... etc/ +│ │ │ ├── avatar.d.ts/ +│ │ │ └── ... etc/ │ │ ├── ui.config.ts/ # Configuration file used to apply styles to every component ├── colors.ts/ # Everything related to color functions (e.g., safelistByComponent, generateSafelist) └── ... etc/ # Other files and folders From 6f3bd9d03cf2a48e126e329fb2fdf8d4129f8d4b Mon Sep 17 00:00:00 2001 From: Haytham Salama Date: Thu, 28 Sep 2023 20:11:09 +0300 Subject: [PATCH 13/14] docs: add type checking --- docs/content/1.getting-started/6.contributing.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/content/1.getting-started/6.contributing.md b/docs/content/1.getting-started/6.contributing.md index bdaa8e56ea..136fd69cd1 100644 --- a/docs/content/1.getting-started/6.contributing.md +++ b/docs/content/1.getting-started/6.contributing.md @@ -74,6 +74,14 @@ Since ESLint is already configured to format the code, there's no need for dupli If you have Prettier installed in your editor, we recommend disabling it to avoid conflicts. +#### Type Checking + +We use TypeScript for type checking. You can use the `typecheck` command to check for type errors: + +```sh +pnpm run typecheck +``` + ### 3. Commit Conventions Use Conventional Commits for commit messages with the following format: From afbc7f26d1cbfae9ee2c53011fb385eba8e1239b Mon Sep 17 00:00:00 2001 From: Haytham Salama Date: Fri, 29 Sep 2023 11:59:36 +0300 Subject: [PATCH 14/14] up --- docs/content/1.getting-started/6.contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/1.getting-started/6.contributing.md b/docs/content/1.getting-started/6.contributing.md index 136fd69cd1..7b5bf1cbeb 100644 --- a/docs/content/1.getting-started/6.contributing.md +++ b/docs/content/1.getting-started/6.contributing.md @@ -45,7 +45,7 @@ pnpm run dev - To test the components located in the `playground` folder within `app.vue`, run: ```sh -pnpm run dev:play +pnpm run play ``` #### IDE Setup