mirror of
https://github.com/owncast/owncast.git
synced 2024-10-10 19:16:02 +00:00
dab7914eab
* Commit updated Javascript packages * Bump preact from 10.5.4 to 10.5.5 in /build/javascript (#265) * Trying a new github workflow to install javascript packages * Bump tailwindcss from 1.9.2 to 1.9.4 in /build/javascript (#266) Bumps [tailwindcss](https://github.com/tailwindlabs/tailwindcss) from 1.9.2 to 1.9.4. - [Release notes](https://github.com/tailwindlabs/tailwindcss/releases) - [Changelog](https://github.com/tailwindlabs/tailwindcss/blob/master/CHANGELOG.md) - [Commits](https://github.com/tailwindlabs/tailwindcss/compare/v1.9.2...v1.9.4) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Commit updated Javascript packages * Bump preact from 10.5.4 to 10.5.5 in /build/javascript Bumps [preact](https://github.com/preactjs/preact) from 10.5.4 to 10.5.5. - [Release notes](https://github.com/preactjs/preact/releases) - [Commits](https://github.com/preactjs/preact/compare/10.5.4...10.5.5) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Gabe Kangas <gabek@real-ity.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Owncast <owncast@owncast.online> * Bump @justinribeiro/lite-youtube in /build/javascript Bumps [@justinribeiro/lite-youtube](https://github.com/justinribeiro/lite-youtube) from 0.9.0 to 0.9.1. - [Release notes](https://github.com/justinribeiro/lite-youtube/releases) - [Commits](https://github.com/justinribeiro/lite-youtube/commits) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Owncast <owncast@owncast.online> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Gabe Kangas <gabek@real-ity.com>
31 lines
1.1 KiB
Markdown
31 lines
1.1 KiB
Markdown
# CONTRIBUTING
|
|
|
|
We welcome contributions from everyone!
|
|
|
|
## Getting Started
|
|
|
|
Make sure you have NodeJS 4.0 or higher and npm installed.
|
|
|
|
1. Fork this repository and clone your fork
|
|
1. Install dependencies: `npm install`
|
|
1. Run a development server: `npm start`
|
|
|
|
### Making Changes
|
|
|
|
Refer to the [video.js plugin conventions][conventions] for more detail on best practices and tooling for video.js plugin authorship.
|
|
|
|
When you've made your changes, push your commit(s) to your fork and issue a pull request against the original repository.
|
|
|
|
### Running Tests
|
|
|
|
Testing is a crucial part of any software project. For all but the most trivial changes (typos, etc) test cases are expected. Tests are run in actual browsers using [Karma][karma].
|
|
|
|
- In all available and supported browsers: `npm test`
|
|
- In a specific browser: `npm run test:chrome`, `npm run test:firefox`, etc.
|
|
- While development server is running (`npm start`), navigate to [`http://localhost:9999/test/`][local]
|
|
|
|
|
|
[karma]: http://karma-runner.github.io/
|
|
[local]: http://localhost:9999/test/
|
|
[conventions]: https://github.com/videojs/generator-videojs-plugin/blob/master/docs/conventions.md
|