Skip to content

Latest commit

 

History

History
85 lines (56 loc) · 4.79 KB

CONTRIBUTING.md

File metadata and controls

85 lines (56 loc) · 4.79 KB
Raw

If you're on this page, you must be interested in spending some time giving back to this humble project. If that's the case, here are some ways you can help build the future of the Video.js SWF:

  • Features and changes
  • Bug reports and fixes
  • Answer questions on Stack Overflow
  • Related Video.js projects

##Getting Started

  1. Fork the video-js-swf git repository. At the top of every github page, there is a Fork button. Click it, and the forking process will copy video-js-swf into your organization. You can find more information on Forking a Github repository here.

  2. Clone your fork of the video-js-swf repo, and assign the original repo to a remote called "upstream"

git clone https://github.com/<your-username>/video-js-swf.git
cd video-js-swf
git remote add upstream https://github.com/videojs/video-js-swf.git

In the future, if you want to pull in updates to video-js-swf that happened after you cloned the main repo, you can run:

git checkout master
git pull upstream master
  1. Depending on whether you're adding something new, making a change or fixing a bug, you'll want to do some up-front preparation.

If you're adding new functionality, you only need to create a new branch for your work. When you submit a Pull Request, Github automatically opens a new issue to track it.

If you're fixing a bug, please submit an issue for it. If you're fixing an existing bug, claim it by adding a comment to it. This will give a heads-up to anyone watching the issue that you're working on a fix. Please refer to the Filing Bugs section below for some guidelines on filing new issues.

  1. Create a new branch for your work, and make your changes.

  2. Thoroughly test your feature or fix. See the guide for running the unit and integration tests in the README. Adding new tests is both highly encouraged and appreciated. In addition to the automated tests, and testing the area(s) specific to the area you're working on, a brief smoketest of the player never hurts. We'd like to suggest this short smoke test with both FLV and MP4 video formats:

  3. Playback should start after clicking Play overlay

  4. Playback should start after clicking Play button

  5. Playback should pause when clicking the Pause button

  6. Seeking should work by clicking in the timeline

  7. Seeking should work by dragging the scrubber in the timeline

  8. Full screen (and restore from Full-screen) should work

  9. Replay (without refreshing the browser) should work

(This may seem like a lot of steps, but they could all be accomplished with a couple of short-duration test files, within a few minutes.)

  1. After committing your changes to your fork of the repo, submit your Pull Request. If you are changing the source code, make sure to submit a second pull request to the main Video.js repo. This must be done to change the copy of video-js.swf that Video.js uses. When you run build.sh, video-js.swf is always updated to contain the latest changes you have in video-js-swf.

##Filing Bugs

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful. Thank You!

Guidelines for bug reports:

  • Use the GitHub issue search — check if the issue has already been reported.
  • Check if the issue has been fixed — try to reproduce it using the latest master branch in the repository.
  • Isolate the problem — ideally create a reduced test case and a live example.

A good bug report should be as detailed as possible, so that others won't have to follow up for the essential details.

Here's an example:

Summary: Short yet concise Bug Summary

Description: Happens on Windows 7 and OSX. Seen with IE9, Firefox 19 OSX, Chrome 21, Flash 11.6 and 11.2

    This is the first step
    This is the second step
    Further steps, etc.

Expected: (describe the expected outcome of the steps above)

Actual: (describe what actually happens)

<url> (a link to the reduced test case, if it exists)

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

####NOTE: Testing Flash Locally in Chrome

Chrome 21+ (as of 2013/01/01) doens't run Flash files that are local and loaded into a locally accessed page (file:///). To get around this you can do either of the following:

  1. Do your development and testing using a local HTTP server. See the README for instructions on using simple-http-server for this purpose.
  2. Disable the version of Flash included with Chrome and enable a system-wide version of Flash instead.

Other Video.js Projects Video.js - Our open source HTML5 & Flash video player. Videojs.com - The public site with helpful tools and information about Video.js.