|
|
@@ -15,9 +15,15 @@ Before local development, please make sure that Git and Node.js are installed in
|
|
|
|
|
|
Debugging STDF requires an engineering environment. For this purpose, a simple Demo project is provided. STDF itself is not limited by the Node version, and the Demo uses Vite for development, so please ensure that your Node.js version >= 14.18+, refer to the [Vite official website](https://cn.vitejs.dev/guide/#scaffolding-your-first-vite-project).
|
|
|
|
|
|
-> Recommended: Use [pnpm](https://pnpm.io/zh) for package management; install [VSCode plugin](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode) or [WebStorm plugin](https://plugins.jetbrains.com/plugin/12375-svelte) for Svelte development; install [VSCode plugin](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss) for Tailwind, WebStorm is integrated by default, [learn more](https://www.jetbrains.com/help/webstorm/tailwind-css.html).
|
|
|
+Before submitting a PR after you have made code modifications, please ensure that you have formatted the code and passed the code formatting check. You can install relevant editor plugins or use the command line for code formatting.
|
|
|
|
|
|
-Follow the steps below to quickly start the STDF Demo locally.
|
|
|
+Recommended installations:
|
|
|
+
|
|
|
+- [pnpm](https://pnpm.io/zh): Package management tool.
|
|
|
+- [Svelte for VS Code](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode) or [Svelte](https://plugins.jetbrains.com/plugin/12375-svelte): Svelte development plugin.
|
|
|
+- [Tailwind CSS IntelliSense](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss) or [WebStorm integration](https://www.jetbrains.com/help/webstorm/tailwind-css.html): Tailwind CSS development plugin.
|
|
|
+- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) or [WebStorm integration](https://www.jetbrains.com/help/webstorm/eslint.html): Code formatting check plugin.
|
|
|
+- [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) or [WebStorm integration](https://www.jetbrains.com/help/webstorm/prettier.html): Code formatting plugin.
|
|
|
|
|
|
> Because the stdf and rollup-plugin-stdf-icon packages that the demo depends on are locally built, please build these two packages first.
|
|
|
|
|
|
@@ -67,8 +73,11 @@ If you are submitting a Pull Request on GitHub for the first time, you can read
|
|
|
- Clone your repository to your local machine.
|
|
|
- Modify the component source code and verify it in the Demo.
|
|
|
- 「Optional」Supplement the Chinese and English documentation for this modification, which is located in the `doc/components` directory. Depending on the specific modification content, you may need to modify the api, FAQ, guide, version, and other documents. For modifications to version, please add tags. Please refer to the [STDF Version tag](https://github.com/dufu1991/stdf/blob/main/doc/components/button/version.md?plain=1) for specific details.
|
|
|
-- Submit the modified content to your repository, and then submit a Pull Request to the main repository.
|
|
|
-- The Pull Request will be merged into the main repository after review and a new version will be released to npm.
|
|
|
+- Go to the root directory of the repository and execute `pnpm i` or `npm i` to install dependencies.
|
|
|
+- Use your editor to format the modified code or execute `pnpm run format` or `npm run format` in the command line to format the code.
|
|
|
+- Execute `pnpm run lint` or `npm run lint` to check the code formatting.
|
|
|
+- Commit the modified content to your repository and then submit a Pull Request to the main repository.
|
|
|
+- The Pull Request will be merged into the main repository after it passes the review and a new version will be released subsequently.
|
|
|
|
|
|
### Notes
|
|
|
|
dufu1991