From 418e34288b322d401278bd0b98683430e5366e0f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Levi=20=28Nguy=E1=BB=85n=20L=C6=B0=C6=A1ng=20Huy=29?= Date: Wed, 25 Oct 2023 11:42:08 +0700 Subject: [PATCH 1/2] docs(README): add development guide --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index f8460cf31c..5596a8a89a 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,15 @@ Visit https://ui.nuxt.com to explore the documentation. - [vueuse/vueuse](https://github.com/vueuse/vueuse) - [egoist/tailwindcss-icons](https://github.com/egoist/tailwindcss-icons) +## Development + +- Clone this repository. +- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`. +- Install dependencies using `pnpm install`. +- Run `pnpm dev:prepare` to generate type stubs. +- Use `pnpm play` to start [playground](https://github.com/nuxt/ui/tree/main/playground) in development mode. +- Use `pnpm dev` to start [docs](https://github.com/nuxt/ui/tree/main/docs) in development mode. + ## License Licensed under the [MIT license](https://github.com/nuxt/ui/blob/dev/LICENSE.md). From a38bea89271a5cc814423ddeb87ed9537e804a0f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Levi=20=28Nguy=E1=BB=85n=20L=C6=B0=C6=A1ng=20Huy=29?= Date: Mon, 30 Oct 2023 20:03:53 +0700 Subject: [PATCH 2/2] up --- README.md | 18 +++--- .../1.getting-started/6.contributing.md | 59 ++++++++----------- 2 files changed, 35 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 5596a8a89a..d1081889bd 100644 --- a/README.md +++ b/README.md @@ -71,14 +71,16 @@ Visit https://ui.nuxt.com to explore the documentation. - [vueuse/vueuse](https://github.com/vueuse/vueuse) - [egoist/tailwindcss-icons](https://github.com/egoist/tailwindcss-icons) -## Development - -- Clone this repository. -- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`. -- Install dependencies using `pnpm install`. -- Run `pnpm dev:prepare` to generate type stubs. -- Use `pnpm play` to start [playground](https://github.com/nuxt/ui/tree/main/playground) in development mode. -- Use `pnpm dev` to start [docs](https://github.com/nuxt/ui/tree/main/docs) in development mode. +## Contributing + +Thank you for considering contributing to Nuxt UI. Here are a few ways you can get involved: + +- Reporting Bugs: If you come across any bugs or issues, please check out the reporting bugs guide to learn how to submit a bug report. +- Suggestions: Have any thoughts to enhance Nuxt UI? We'd love to hear them! Check out the [contribution guide](https://ui.nuxt.com/getting-started/contributing) to share your suggestions. + +## Local Development + +Follow the docs to [Set up your local development environment](https://ui.nuxt.com/getting-started/contributing#_2-local-development-setup) and contribute. ## License diff --git a/docs/content/1.getting-started/6.contributing.md b/docs/content/1.getting-started/6.contributing.md index 7b5bf1cbeb..62e2754296 100644 --- a/docs/content/1.getting-started/6.contributing.md +++ b/docs/content/1.getting-started/6.contributing.md @@ -9,7 +9,7 @@ Nuxt UI thrives thanks to its fantastic community ❤️, which contributes by s 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 +## Submitting a Pull Request (PR) ### 1. Before You Start @@ -27,22 +27,33 @@ To begin local development, follow these steps: git clone https://github.com/nuxt/ui.git ``` -2. Install dependencies and prepare the project: +2. Enable [Corepack](https://github.com/nodejs/corepack): + +```sh +corepack enable +``` + +3. Install dependencies: ```sh pnpm install +``` + +4. Generate type stubs: + +```sh pnpm run dev:prepare ``` -3. To configure your local development environment, use the following commands: +5. Configure your local development environment: -- To work on the **documentation** in the `docs` folder, run: +- To work on the **documentation** located in the `docs` folder, run: ```sh pnpm run dev ``` -- To test the components located in the `playground` folder within `app.vue`, run: +- To test the components using **playground**, run: ```sh pnpm run play @@ -84,46 +95,26 @@ pnpm run typecheck ### 3. Commit Conventions -Use Conventional Commits for commit messages with the following format: +We use [Conventional Commits](https://www.conventionalcommits.org/) for commit messages, which allows a changelog to be auto-generated based on the commits. Please read the [guide](https://www.conventionalcommits.org/en/v1.0.0/#summary) through if you aren't familiar with it already. -``` -(optional scope): +#### Note -[optional body] +- `fix` and `feat` are for actual code changes (that might affect logic). For typo or document changes, use `docs` or `chore` instead: -[optional footer(s)] -``` - -#### 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 documentation. -- `chore` : for anything else. - -#### Scope +~~`fix: typo`~~ -> `docs: fix typo` -Where the change occurred (e.g., `Table`, `Alert`, `Accordion`, etc.). - -#### Description - -A summary of the changes made. - -#### Examples +- If you are working on a specific component, ensure that you specify the main scope of your commit in brackets. e.g. ``` feat(Alert): new component chore(Table): improve accessibility -docs: migrate to @nuxt/ui-pro ``` -### 4. Making the Pull Request +### 4. Making a Pull Request + +- Follow along the [instructions](https://github.com/nuxt/ui/blob/main/.github/PULL_REQUEST_TEMPLATE.md?plain=1) provided when creating a PR -- 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. +- Ensure your PR's title adheres to the [Conventional Commits](https://www.conventionalcommits.org/) since it will be used once the code is merged. - Multiple commits are fine; no need to rebase or force push. We'll use `Squash and Merge` when merging.