π¬ A browser extension and desktop app that turns your clicks into step-by-step guides with annotated screenshots π
TypeScript browser-extensionchrome-extensiondocumentationfirefox-extensionguide-generatorlocal-firstmanifest-v3privacy-firstproductivityreactscreenshotstep-by-step-guidetutorialtypescriptworkflowwxt
chore(github): add pull request and issue templates
Luis Ortiz435ff31b259a
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.ymlnew file mode 100644index 0000000..7c9a352--- /dev/null+++ b/.github/ISSUE_TEMPLATE/bug_report.yml@@ -0,0 +1,94 @@+name: Bug report+description: Something in Mimik does not work+title: "[Bug] "+labels: [bug, needs-triage]+body:+ - type: checkboxes+ id: preflight+ attributes:+ label: Before you report+ options:+ - label: I searched existing issues to avoid a duplicate.+ required: true+ - label: I reproduced this myself, rather than having a tool report it.+ required: true+ - label: I can reproduce it on the latest version.+ required: false+ - label: I can reproduce it in a clean browser profile with Mimik as the only extension.+ required: false++ - type: markdown+ attributes:+ value: |+ Suggesting something new instead? Use the [feature request form](https://github.com/westpoint-io/mimik/issues/new?template=feature_request.yml).++ - type: textarea+ id: behaviour+ attributes:+ label: Current vs expected behaviour+ description: >+ What happened, and what you expected instead. Screenshots help a lot.+ Incomplete reports may be closed without investigation.+ placeholder: I exported a guide as PDF and expected A, but got B.+ validations:+ required: true++ - type: textarea+ id: steps+ attributes:+ label: Steps to reproduce+ placeholder: |+ 1. Start a recording on example.com+ 2. Click a couple of things, then stop+ 3. Export as PDF+ 4. Observe ...+ validations:+ required: true++ - type: dropdown+ id: areas+ attributes:+ label: Which areas are affected?+ multiple: true+ options:+ - Recording and capture+ - Guide editor+ - Screenshot editor, annotation or crop+ - Smart Blur+ - Export (PDF, DOCX, HTML, Markdown)+ - Export (video)+ - Guide Me replay+ - Voice narration+ - AI descriptions+ - Onboarding or settings+ - Other+ validations:+ required: true++ - type: textarea+ id: environment+ attributes:+ label: Environment+ render: text+ placeholder: |+ - Browser: Chrome 140 / Firefox 145 / Edge 140+ - Mimik version: 1.1.1+ - OS: macOS 15, Windows 11, Ubuntu 26.04+ - Site being recorded, if it matters:+ validations:+ required: true++ - type: textarea+ id: console+ attributes:+ label: Console errors+ description: >+ Chrome: chrome://extensions, Mimik, "service worker", Console.+ Firefox: about:debugging, Inspect. Paste anything red.+ render: text++ - type: textarea+ id: additional+ attributes:+ label: Additional context+ description: Anything else that helps. If you used an AI tool to write this report, say so here and confirm you verified every claim in it.diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.ymlnew file mode 100644index 0000000..cfea9ec--- /dev/null+++ b/.github/ISSUE_TEMPLATE/config.yml@@ -0,0 +1,8 @@+blank_issues_enabled: false+contact_links:+ - name: Security vulnerability+ url: https://github.com/westpoint-io/mimik/security/advisories/new+ about: Report privately. Do not open a public issue.+ - name: Question or idea to talk through+ url: https://github.com/westpoint-io/mimik/blob/main/CONTRIBUTING.md+ about: Read the contributing guide first.diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.ymlnew file mode 100644index 0000000..5c6c29c--- /dev/null+++ b/.github/ISSUE_TEMPLATE/feature_request.yml@@ -0,0 +1,61 @@+name: Feature request+description: Suggest something Mimik should do+title: "[Feature] "+labels: [enhancement, needs-triage]+body:+ - type: checkboxes+ id: preflight+ attributes:+ label: Before you begin+ options:+ - label: I searched existing issues to avoid a duplicate.+ required: true+ - label: I am willing to open a PR for this.+ required: false++ - type: markdown+ attributes:+ value: |+ Reporting something broken instead? Use the [bug report form](https://github.com/westpoint-io/mimik/issues/new?template=bug_report.yml).++ - type: textarea+ id: problem+ attributes:+ label: The problem+ description: What are you trying to do that Mimik makes hard today?+ validations:+ required: true++ - type: textarea+ id: solution+ attributes:+ label: What you would want+ description: Rough is fine. Say what it should do, not how to build it.+ validations:+ required: true++ - type: dropdown+ id: areas+ attributes:+ label: Which areas would this affect?+ multiple: true+ options:+ - Recording and capture+ - Guide editor+ - Screenshot editor, annotation or crop+ - Smart Blur+ - Export (PDF, DOCX, HTML, Markdown)+ - Export (video)+ - Guide Me replay+ - Voice narration+ - AI descriptions+ - Onboarding or settings+ - Other+ validations:+ required: true++ - type: textarea+ id: context+ attributes:+ label: Additional context+ description: Screenshots, mockups, or how other tools solve it. If you used an AI tool to write this, say so here.diff --git a/.github/pull_request_template.md b/.github/pull_request_template.mdnew file mode 100644index 0000000..547d75f--- /dev/null+++ b/.github/pull_request_template.md@@ -0,0 +1,40 @@+> **AI model(s) used (required):** <!-- Name every model you used, or write "None". You are responsible for every line either way. -->++## Type of change++<!-- Tick one. -->++- [ ] β¨ New feature (feat)+- [ ] π Bug fix (fix)+- [ ] β»οΈ Refactor (refactor)+- [ ] β‘ Performance (perf)+- [ ] π Translation or locale (i18n)+- [ ] π Documentation (docs)+- [ ] β Tests only (test)+- [ ] π§ Tooling or dependencies (chore)++## Description++<!-- Two sentences: what changed and why. Write it yourself. Don't paste a+ generated summary of the diff, we can read the diff. -->++## Related issue++Closes #++## How this was tested++- [ ] `pnpm lint && pnpm test && pnpm build && pnpm build:firefox` passes locally <!-- CI does not run on fork PRs until a maintainer approves it. -->+- [ ] Tested by hand in the browser+- [ ] Tests added or updated++## Screenshots++<!-- Required for any UI change. Mimik is a visual tool and a green test run+ does not show whether a guide still looks right. -->++## Checklist++- [ ] I can explain and debug every line, without going back to an AI tool+- [ ] Commits follow [Conventional Commits](https://www.conventionalcommits.org)+- [ ] Existing behaviour still works