0 Fork 0

mirror of https://github.com/PR0M3TH3AN/bitvid.git synced 2026-10-27 16:02:26 +00:00

Files

T

google-labs-jules[bot] 09545c869c docs(ai): improve onboarding steps and add devcontainer

- Update README.md to recommend `npm ci` and include test steps.
- Update CONTRIBUTING.md with explicit development setup instructions.
- Add `.devcontainer/devcontainer.json` for reproducible Node 20 environment.
- Add audit report in `ai/reports/onboarding-20260118.md`.

2026-01-18 08:23:14 +00:00

2.0 KiB

Raw Blame History

Contributing to bitvid

Thanks for helping build an open video ecosystem on nostr!

License Model

App (this repo): GPL-3.0-or-later
Potential SDKs/embeds (if split later): Apache-2.0 (to keep integration friction low)

All contributions to this repository are made under the repository’s license (GPL-3.0-or-later).

Developer Certificate of Origin (DCO)

We use the DCO to keep contributions simple and legally sound. Sign your commits with -s:

git commit -s -m "feat: add cool thing"

This adds a Signed-off-by: Your Name <[email protected]> line and certifies you have the right to contribute under the project license. See https://developercertificate.org/ for the full text.

(Optional) Contributor License Agreement (CLA)

If we later introduce dual-licensing options (e.g., commercial licenses for enterprises), we may add an optional CLA for contributors who want to grant relicense rights. You will be asked to agree explicitly in any PR that requires it. We will keep community use under GPL-3.0-or-later.

Code Guidelines

Prefer small, focused PRs.
Add tests where reasonable; keep UI accessible.
Follow existing formatting/lint rules.
Update docs and user-facing text when behavior changes.

Development Setup

To set up the project locally:

Install Dependencies:
```
npm ci
```
Run Tests:
```
npm run test:unit
```
Format & Lint:
```
npm run format
npm run lint
```

For a full guide, see the Local Setup section in README.md.

Security

If you find a vulnerability, please email [email protected]. We’ll coordinate a responsible disclosure window before public release.

Trademark

The bitvid name and logos are trademarks (see TRADEMARKS.md). Don’t use them in ways that imply official sponsorship or confuse users. “Powered by bitvid” attribution is encouraged.

2.0 KiB Raw Blame History Unescape Escape