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
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Bug report
about: Report something broken in supercut
title: "bug: "
labels: bug
---

## What happened?

## Expected behavior

## Steps to reproduce

1.
2.
3.

## Environment

- OS:
- Node version:
- supercut version/commit:

## Logs or screenshots
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/demo_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Demo request
about: Request or submit a product demo made with supercut
title: "demo: "
labels: demo
---

## Product URL

## Best 3-4 moments to show

1.
2.
3.
4.

## Target audience

## Preferred style

- Fast launch trailer
- Calm product walkthrough
- Developer-tool demo
- Other:
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest a new supercut capability
title: "feat: "
labels: enhancement
---

## Problem

What user pain does this solve?

## Proposal

What should supercut do?

## Alternatives considered

## Example output

If this is visual, include a screenshot, mockup, or sample video.
7 changes: 7 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Code of Conduct

supercut should be a useful, welcoming project for builders, designers, and open-source contributors.

Be respectful, constructive, and specific. Harassment, personal attacks, and discriminatory behavior are not welcome.

If you report a problem, include enough context for maintainers to understand and act on it. Maintainers may remove comments, close issues, or block users who make the project unsafe or unproductive.
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Contributing to supercut

Thanks for helping build supercut.

## Local setup

```bash
npm install
npm run build
npm run test

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Document E2E prerequisites before running tests

In a fresh checkout this setup stops at npm run test: package.json maps that to vitest run, so it also runs the E2E specs (test/record.e2e.test.ts and test/generate.e2e.test.ts) that require Chromium plus ffmpeg/ffprobe, and the README already calls out those prerequisites for npm run test:e2e. Please either use the fast test target here or add the Playwright/ffmpeg setup step before asking new contributors to run the full suite.

Useful? React with 👍 / 👎.

```

## Good first contributions

Good starter tasks usually improve one narrow part of the project:

- add or improve a recipe in `examples/`,
- add tests for schema validation,
- improve CLI error messages,
- document a recorder or renderer edge case,
- add a small render theme or background asset.

## Pull request checklist

Before opening a PR:

- Run `npm run build`.
- Run `npm run test`.
- Keep the PR focused on one change.
- Add or update tests when behavior changes.
- Include screenshots, videos, or generated artifacts for visual changes.

## Project principles

- Real product footage beats mockups.
- The event log is a public contract.
- Non-AI recorder/render paths should remain useful without an API key.
- Defaults should produce a launch-ready video, not a raw screen recording.
Loading