Skip to content

Commit 6dd08af

Browse files
authored
Prepare repo for writing Proposals (#5)
1 parent 56888a4 commit 6dd08af

File tree

3 files changed

+27
-9
lines changed

3 files changed

+27
-9
lines changed

template.md renamed to 0000-template.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ One paragraph explanation of the feature.
1111
[motivation]: #motivation
1212

1313
Why are we doing this? What use cases does it support? What is the expected outcome?
14+
Consider listing any specific Goals and Non-Goals as sub-sections.
1415

1516
# Guide-level Explanation
1617
[guide-level-explanation]: #guide-level-explanation
@@ -61,4 +62,4 @@ If there is no prior art, that is fine - your ideas are interesting to us whethe
6162

6263
- What parts of the design do you expect to resolve through the proposal process before this gets merged?
6364
- What parts of the design do you expect to resolve through the implementation of this feature before stabilization?
64-
- What related issues do you consider out of scope for this proposal that could be addressed in the future independently of the solution that comes out of this proposal?
65+
- What related issues do you consider out of scope for this proposal that could be addressed in the future independently of the solution that comes out of this proposal?

README.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,33 @@
11
# media-ui-extensions
22
Extending the HTMLVideoElement API (`<video>`) to support advanced video player user-interface features
33

4-
With the addition of [web components](https://developer.mozilla.org/en-US/docs/Web/Web_Components) to the browser, video player developers can create custom elements that mimic the video tag API, with goals of creating stand-in compatiblity with the video tag and compatibility across players. The video tag API is however lacking some important functions to support modern player UIs, including playback quality/resolution selection and awareness of ads. This repo is intended to capture requests and proposals for those functions.
4+
With the addition of [Web Components](https://developer.mozilla.org/en-US/docs/Web/Web_Components) to the browser, video player developers can create custom elements that mimic the video tag API, with goals of creating stand-in compatibility with the video tag and compatibility across players. The video tag API is however lacking some important functions to support modern player UIs, including playback quality/resolution selection and awareness of ads. This repo is intended to capture requests and proposals for those functions.
55

6-
## Submitting a proposal
7-
Use `template.md` to frame your proposal and make a pull-request to add your proposal document to the `proposals` directory.
6+
## Goals for Proposals
7+
We want these proposals to be something that we can eventually propose to the Media WG or WhatWG as additional features to the video element and anything related. In the meantime, proposals accepted to media-ui-extensions can be used as a specification to keep things interoperable between implementers.
8+
9+
## Before submitting a proposal
10+
If you have a new idea, it might be worth creating an issue to discuss it a bit first before submitting a proposal to make sure that it's something could be a good fit and won't be less likely to be rejected later on.
811

9-
Inspired by [rust-lang/rfcs](https://github.com/rust-lang/rfcs) via [video-dev/hlsjs-rfcs](https://github.com/video-dev/hlsjs-rfcs).
12+
## Submitting a proposal
13+
- Fork the repo
14+
- Copy `0000-template.md` to `proposals/0000-your-feature.md`. Don't change the number yet as that will be updated when the PR is created.
15+
- Fill out your proposal with as much detail as possible.
16+
- Submit a pull request. Once the PR is created, a new commit can be made to update the filename `0000-` prefix and the header of the file to point to the new PR number.
17+
- Folks should now review the proposal and suggest changes. While in the PR, it's expected that many changes may be made. Ideally, please don't rebase commits in the branch as it'll make reviewing only new changes easier.
18+
- At some point, a committer should issue a Call for Consensus (CfC). This CfC will include whether this proposal should be accepted, rejected, or postponed.
19+
- The CfC will last a minimum of 2 weeks to make sure that all collaborators gets a chance to review. If all relevant parties have explicitly finished reviewing before 2 weeks, the CfC may end early.
20+
- If there is enough consensus, the CfC will close successfully. If there is no consensus, the proposal could be rejected or go back to be re-edited.
1021

11-
## Submitting a request
12-
Use the github issues to request and disucss a desired feature/function at a high level.
22+
## Implementing a proposal
23+
Once a proposal has been accepted, it can start to be implemented. If during implementation, major issues are found, the existing proposal shouldn't be updated but a new proposal should be issued. The old proposal should be updated to link to the new proposal.
1324

1425
## Resources
15-
* [MDN video element docs](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video)
16-
* [WHATWG spec](https://html.spec.whatwg.org/multipage/media.html#the-video-element)
26+
- [MDN video element docs](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video)
27+
- [WHATWG spec](https://html.spec.whatwg.org/multipage/media.html#the-video-element)
28+
- [Media Working Group](https://github.com/w3c/media-wg/)
29+
30+
## Inspiration
31+
- [rust-lang/rfcs](https://github.com/rust-lang/rfcs) via [video-dev/hlsjs-rfcs](https://github.com/video-dev/hlsjs-rfcs).
32+
- [WebKit Explainers](https://github.com/WebKit/explainers)
33+

proposals/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)