diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..a8710ee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,33 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '...' +3. Scroll down to '...' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Environment** +- OS: [e.g. Windows 11, macOS 14] +- Browser: [e.g. Chrome 126, Firefox 127] +- StreamHive audio mode: [Selection / Both/All / SmartVoiceSwitch] +- Number of streams in the grid: [e.g. 3] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..4a236ad --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,24 @@ +## What changed + + + +## Type of change + +- [ ] `feat` — new feature +- [ ] `fix` — bug fix +- [ ] `perf` — performance improvement +- [ ] `refactor` — no behavior change +- [ ] `docs` — documentation only +- [ ] `test` — adding or fixing tests +- [ ] `chore` — tooling, dependencies, maintenance + +## Target branch + +> [!WARNING] +> This PR must target `dev`. PRs opened against `main` will not be merged — see [Branch workflow](README.md#branch-workflow). + +## Checklist + +- [ ] Tested locally +- [ ] Build passes +- [ ] `c-docs/NOTES.md` updated if this is a notable change (internal file, not part of this repo — skip if not applicable) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..ca5c942 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +joaosilva98.work@gmail.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b05de0e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,72 @@ +# Contributing to StreamHive + +Thank you for taking the time to contribute! Please read these guidelines before opening an issue or pull request. + +> [!IMPORTANT] +> This project has a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold it. + +--- + +## Ways to contribute + +- **Bug reports** — open an issue describing what happened, what you expected, and your environment (browser, OS) +- **Feature requests** — open an issue describing the use case before writing code, so the approach can be discussed first +- **Code changes** — bug fixes, performance improvements, approved features + +--- + +## Before opening a pull request + +> [!WARNING] +> Target the **`dev`** branch. Do **not** target `main` — it is the stable branch, merged from `dev` manually, only when a milestone is ready. Pull requests against `main` will not be merged. + +- One change per PR — keep scope focused +- For significant changes, open an issue first to discuss the approach before investing time in the implementation + +--- + +## Commit message convention + +Use a semantic prefix: + +| Prefix | When to use | +|---|---| +| `feat:` | New feature | +| `fix:` | Bug fix | +| `perf:` | Performance improvement | +| `refactor:` | Code change with no behaviour change | +| `docs:` | Documentation only | +| `test:` | Adding or fixing tests | +| `chore:` | Build, config, or tooling changes | + +> [!NOTE] +> Example: `feat: add SmartVoiceSwitch audio mode` + +--- + +## Setting up locally + +**Requirements:** Node.js (LTS), Git + +```bash +git clone https://github.com/scr0ols/StreamHive.git +cd StreamHive +git checkout dev + +> [!NOTE] +> Full install/run instructions aren't available yet — the project isn't runnable end to end until the frontend and backend scaffolds land (Phase 0). Check the [Setup](README.md#setup) section of the README for current status. + +--- + +## Code style + +- Follow the conventions already present in the file you're editing +- No commented-out code, no leftover debug prints +- Keep changes scoped — don't refactor unrelated code in the same PR + +--- + +## Questions + +> [!TIP] +> Open an issue if you're unsure about anything before starting work. diff --git a/README.md b/README.md new file mode 100644 index 0000000..bc6acb1 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# StreamHive + +Watch 2 to 5 Twitch channels at once in a single grid, using the official Twitch Embed API for video and chat. No setup required on the streamers' side. Three audio modes (Selection, Both/All, and an exploratory SmartVoiceSwitch), plus layout templates saved to a lightweight account via Twitch OAuth login. + +## Stack + +- **Frontend:** React (Vite) +- **Backend:** Node.js + Express +- **Database:** Postgres, hosted free on [Neon](https://neon.tech) +- **Hosting:** Backend on Render's free web service tier, frontend on a static host (Vercel/Netlify) + +Full architecture, data model, and reasoning behind these choices are kept in local planning notes outside this repository (not part of what's cloned from GitHub). + +## Status + +Early planning complete, implementation starting. + +## Setup + +Not yet runnable end to end. This section will be filled in as the backend and frontend scaffolds land (Phase 0 of the implementation plan). + +## Branch workflow + +- `dev` — all development happens here. +- `main` — stable branch, merged from `dev` manually, only when a milestone is ready. +- `docs` — owns documentation-only changes (wiki, README, contributing guidelines, PR templates). + +Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) (`feat:`, `fix:`, `chore:`, `docs:`, `refactor:`, `perf:`, `test:`). diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..bb6347c --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,15 @@ +# Security Policy + +StreamHive is currently in early development and not yet deployed to +production. There are no versioned releases yet, so there's nothing to list +in a supported-versions table — this policy will gain one once the project +ships its first stable release. + +## Reporting a Vulnerability + +If you find a security vulnerability, please report it privately using +GitHub's [Private vulnerability reporting](../../security/advisories/new) +feature rather than opening a public issue. + +As a solo project, response times aren't guaranteed, but reports will be +acknowledged and looked at as soon as possible.