Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 78 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: Bug Report
description: File a bug report
title: "[BUG]: "
labels: ["bug"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!

- type: textarea
id: what-happened
attributes:
label: What happened?
description:
Describe the bug clearly. What did you see, and what did you expect to
see instead?
placeholder: When I render <ParticleCanvas> with ..., the particles do X.
I expected them to do Y.
validations:
required: true

- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: List the exact steps someone else can follow to see the same
bug.
placeholder: |
1. Install @weburz/particle-canvas
2. Add <ParticleCanvas :config="{ ... }" /> to a page
3. Open the page in <browser>
4. Observe ...
validations:
required: true

- type: input
id: reproduction
attributes:
label: Minimal reproduction
description:
A link to a minimal repro is the single most helpful thing you can
provide. Use StackBlitz, CodeSandbox, or a small public GitHub repo.
placeholder: https://stackblitz.com/edit/...
validations:
required: false

- type: textarea
id: environment
attributes:
label: Environment
description: Versions of the relevant tools and the platform you saw the
bug on.
value: |
- `@weburz/particle-canvas` version:
- Nuxt version:
- Node.js version:
- Package manager (pnpm / npm / yarn / bun) + version:
- OS:
- Browser + version:
validations:
required: true

- type: textarea
id: logs
attributes:
label: Relevant log output
description: Console errors, build output, anything related. No need for
backticks — this auto-formats as a shell block.
render: Shell

- type: textarea
id: screenshots
attributes:
label: Screenshots / video
description: For visual bugs, a screenshot or short screen recording is
worth far more than a description. Drag and drop into the box.
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
blank_issues_enabled: false

contact_links:
- name: Report Issues and/or Bugs
url: https://github.com/Weburz/particle-canvas/issues
about: Please report bugs & other issues here.

- name: Security Policy
url: https://github.com/Weburz/particle-canvas/security/policy
about:
Refer to the Security Policy to report security vulnerabilities or if you
would like to know about how your personal information is used.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Feature Request
description: Suggest a feature request or an enhancement
title: "[ENHANCEMENT]: "
labels: ["enhancement"]

body:
- type: markdown
attributes:
value: |
Thanks for recommending the enhancement!

- type: textarea
id: feature-enhancement
attributes:
label: Explain the feature
description:
Explain the enhancement or feature requests you have in mind, in as much
details as possible.
placeholder: Explain the feature and/or the enhancement in full detail.
value: Implement XYZ feature which provides so and so capabilities to the
website...
validations:
required: true
9 changes: 9 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
## Description

TODO: Include a brief summary about the PR.

## Modifications

TODO: Provide detailed lists of all changes introduced with the PR.

### Fixed issue(s):
63 changes: 63 additions & 0 deletions .github/workflows/deploy-playground.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: "Deploy Playground"

on:
push:
branches:
- main
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: false

jobs:
build:
name: Generate static playground
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v6.0.2

- name: Install pnpm
uses: pnpm/action-setup@v4.2.0
with:
version: 11.1.3

- name: Setup Node.js
uses: actions/setup-node@v6.2.0
with:
node-version: 22
cache: "pnpm"

- name: Install dependencies
run: pnpm install --frozen-lockfile

- name: Prepare module + playground stubs
run: pnpm dev:prepare

- name: Generate static site
run: pnpm exec nuxi generate playground

- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: playground/.output/public

deploy:
name: Deploy to GitHub Pages
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Deploy
id: deployment
uses: actions/deploy-pages@v4
3 changes: 3 additions & 0 deletions .github/workflows/qa.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
name: "Code QA Checks"

on:
push:
branches:
- main
pull_request:
types:
- synchronize
Expand Down
10 changes: 9 additions & 1 deletion playground/nuxt.config.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
export default defineNuxtConfig({
modules: ['../src/module'],
modules: ['@weburz/particle-canvas'],

devtools: { enabled: true },

app: {
baseURL: process.env.NUXT_APP_BASE_URL || '/',
},
compatibilityDate: 'latest',

nitro: {
preset: 'github_pages',
},
})
4 changes: 2 additions & 2 deletions playground/package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"private": true,
"name": "my-module-playground",
"name": "particle-canvas-playground",
"type": "module",
"scripts": {
"dev": "nuxt dev",
"build": "nuxt build",
"generate": "nuxt generate"
},
"dependencies": {
"my-module": "latest",
"@weburz/particle-canvas": "workspace:*",
"nuxt": "^4.4.5"
}
}
11 changes: 3 additions & 8 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading