-
Notifications
You must be signed in to change notification settings - Fork 1
docs: add community health files (CONTRIBUTING, COC, issue templates) #8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
| ``` | ||
|
|
||
| ## 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. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In a fresh checkout this setup stops at
npm run test:package.jsonmaps that tovitest run, so it also runs the E2E specs (test/record.e2e.test.tsandtest/generate.e2e.test.ts) that require Chromium plus ffmpeg/ffprobe, and the README already calls out those prerequisites fornpm 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 👍 / 👎.