From 989349e918d063ebbaedac01a0791d223bd32f4b Mon Sep 17 00:00:00 2001 From: Co-Messi Date: Mon, 15 Jun 2026 09:51:52 +0800 Subject: [PATCH] docs: add community health files (CONTRIBUTING, COC, issue templates) Salvaged from the wip-branding working branch before retiring it: a focused CONTRIBUTING guide tied to the project principles, a short Code of Conduct, and bug/feature/demo issue templates. Fills out GitHub's Community Standards. --- .github/ISSUE_TEMPLATE/bug_report.md | 24 ++++++++++++++ .github/ISSUE_TEMPLATE/demo_request.md | 24 ++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++ CODE_OF_CONDUCT.md | 7 +++++ CONTRIBUTING.md | 38 +++++++++++++++++++++++ 5 files changed, 113 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/demo_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..ab58a2c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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 diff --git a/.github/ISSUE_TEMPLATE/demo_request.md b/.github/ISSUE_TEMPLATE/demo_request.md new file mode 100644 index 0000000..f046d51 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/demo_request.md @@ -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: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..6d5a7fa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..3ad8e11 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..aa46966 --- /dev/null +++ b/CONTRIBUTING.md @@ -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.