ytcn
Reference

Contributing

How to contribute to ytcn — code, docs, or bug reports.

Getting started

1

Fork and clone

bash
git clone https://github.com/your-username/ytcn.git
cd ytcn
npm install
2

Start the dev server

bash
npm run dev

The docs site runs at http://localhost:3000. Component source files are in src/components/ytcn/.

3

Make your changes

Edit components, hooks, or docs. All changes hot-reload in the dev server.

4

Build and test

bash
npm run build

Ensure the build passes with zero TypeScript errors before submitting a PR.

5

Submit a pull request

Push your branch and open a PR against main. Include a clear description of what changed and why.

Guidelines

  • •TypeScript strict: All code must pass tsc --strict with zero errors.
  • •No new dependencies: ytcn intentionally has minimal dependencies. If your change requires a new package, discuss it in an issue first.
  • •Registry sync: If you modify a component or hook, update the corresponding file in registry/ to maintain parity.
  • •Document changes: Update the relevant docs page and add a changelog entry.
  • •Test manually: Verify your changes work across at least Chrome and Firefox. Test fullscreen mode and keyboard shortcuts.

Bug reports

Open an issue on GitHub Issues with:

  • •Browser and version
  • •Video ID that reproduces the issue
  • •Steps to reproduce
  • •Expected vs actual behavior

License

ytcn is released under the MIT License. By contributing, you agree that your contributions will be licensed under the same license.

Previous

Changelog