diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..84e85af --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,46 @@ +## ๐ Type of Change + +Select the type of change that best describes this PR: + +- [ ] ๐ **Feature** (non-breaking change which adds new functionality) +- [ ] ๐ **Bug Fix** (non-breaking change which fixes an issue) +- [ ] โก **Optimization / Refactoring** (code structure or performance improvement) +- [ ] ๐ **Documentation** (README, CHANGELOG, inline JSDoc updates) +- [ ] ๐ฆ **Release** (version bump and release preparation) +- [ ] โ๏ธ **CI/CD & Tooling** (GitHub Actions, build config, scripts) + +--- + +## ๐ Description & Motivation + +Provide a concise summary of the changes introduced in this PR and the problem/user story it resolves. + +--- + +## โจ Key Changes & Highlights + +- Feature/fix item 1 +- Feature/fix item 2 +- Feature/fix item 3 + +--- + +## ๐ธ Screenshots / Demos (If Applicable) + +| Feature | Preview | +| :------------ | :-----------------------------------------: | +| **Feature 1** | | +| **Feature 2** | | + +--- + +## ๐งช Quality & Verification Checklist + +Before submitting this PR, please check and verify the following: + +- [ ] My code follows the project's code style and guidelines. +- [ ] I have executed `pnpm check-types` and verified **0 TypeScript errors**. +- [ ] I have executed `pnpm test` and all unit tests pass **100%**. +- [ ] I have executed `pnpm --filter mobile-devtools build` and the package builds cleanly. +- [ ] I have executed `pnpm --filter web lint` and verified **0 ESLint warnings/errors**. +- [ ] I have updated relevant documentation ([`README.md`](./README.md), [`CHANGELOG.md`](./packages/mobile-devtools/CHANGELOG.md), and inline TSDoc comments) if applicable. diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..2c39729 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,42 @@ +name: CI & Quality Checks + +on: + push: + branches: [master, main] + pull_request: + branches: [master, main] + +jobs: + ci: + name: Typecheck, Build & Test + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Install pnpm + uses: pnpm/action-setup@v4 + with: + version: 9.15.0 + + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: 20 + cache: 'pnpm' + + - name: Install dependencies + run: pnpm install --frozen-lockfile + + - name: Build mobile-devtools package + run: pnpm --filter mobile-devtools build + + - name: Check TypeScript Types + run: pnpm check-types + + - name: Run Unit Tests + run: pnpm test + + - name: Run Web Application Linting + run: pnpm --filter web lint diff --git a/README.md b/README.md index 1fbf5fc..3288bb4 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ [](https://turbo.build/) [](https://react.dev/) [](https://vuejs.org/) +[](https://svelte.dev/) [](https://developer.mozilla.org/en-US/docs/Web/JavaScript) --- @@ -22,6 +23,7 @@ - [๐ Framework Quickstart](#-framework-quickstart) - [โ๏ธ React Integration](#%EF%B8%8F-react-integration) - [๐ Vue 3 Integration](#-vue-3-integration) + - [๐งก Svelte 4/5 Integration](#-svelte-45-integration) - [๐ฆ Vanilla JS / Legacy Apps](#-vanilla-js--legacy-apps) - [โ๏ธ Full Configuration & Props Reference](#%EF%B8%8F-full-configuration--props-reference) - [๐จ Theme Engine & Customization](#-theme-engine--customization) @@ -34,13 +36,13 @@ ## ๐ธ Showcase
-
-
-
+
+
+
-
-
+
+
- mobile-devtools Documentation & Live Demo -
-mobile-devtools. We collect zero personal data,
- store zero tracking cookies, and run 100% locally in your browser.
- - This website serves as the official documentation hub and live interactive demo - environment for{' '} - mobile-devtools, an - open-source React component for in-app mobile browser debugging. -
-- We prioritize your privacy above all else. We do{' '} - NOT: -
-- All devtools interactions, network request interception demos, console log capturing, - and storage inspections occur exclusively inside your browser memory within Shadow - DOM. -
-- Click any action button below and tap the floating DevTools badge in the corner to inspect captured data! + Click any action button below and tap the floating{' '} + DevTools badge in the corner to inspect + captured data!
Trigger console entries to test badge counter & stack trace formatting.
++ Trigger console entries to test badge counter & stack trace formatting. +
+ Count: {count} +
+
+
+
+
+
+
+
+