README: Added links to WPT dashboard, jsdom/whatwg-url and Live URL Viewer. #407
Conversation
…iewer. This gives implementors and editors useful resources to check conformance of various implementations. Also mentions that normative changes will need to update tests and the JS implementation.
README.md
Outdated
| @@ -19,6 +19,11 @@ In short, change `url.bs` and submit your patch, with a | |||
| [good commit message](https://github.com/whatwg/meta/blob/master/COMMITTING.md). Consider | |||
| reading through the [WHATWG FAQ](https://whatwg.org/faq) if you are new here. | |||
|
|
|||
| If your patch makes normative (behavioural) changes, you will be asked to add or update | |||
| [tests](https://github.com/web-platform-tests/wpt), and update the | |||
| [jsdom/whatwg-url](https://github.com/jsdom/whatwg-url) implementation (see "Tests and | |||
There was a problem hiding this comment.
I wouldn't call jsdom/whatwg-url an official implementation, so I'd just say it'd be nice of they could do that but it's not a must.
WPTs are a must though.
There was a problem hiding this comment.
I didn't use the word "official".
This came about from a private discussion I had with @annevk and @domenic, where they pointed me at jsdom/whatwg-url and said new changes to the standard would require people to update jsdom/whatwg-url.
I'm not sure of the "official" status of jsdom/whatwg-url, but it seems it is at least the de facto reference implementation. It's currently kept up-to-date (either by whoever changes the standard, or by someone else shortly afterwards) so that it passes all the tests, and I think it's good to keep it that way. It's best to tell people potentially changing the standard well in advance that this is an expectation, so that a) they'll change it themselves, and b) they are able to use it to test their changes and see how they affect the test suite.
(To put it another way, how can you reasonably expect someone to update WPTs without being able to run their changes against the entire test suite?)
README.md
Outdated
| @@ -19,6 +19,11 @@ In short, change `url.bs` and submit your patch, with a | |||
| [good commit message](https://github.com/whatwg/meta/blob/master/COMMITTING.md). Consider | |||
| reading through the [WHATWG FAQ](https://whatwg.org/faq) if you are new here. | |||
|
|
|||
| If your patch makes normative (behavioural) changes, you will be asked to add or update | |||
There was a problem hiding this comment.
"behavioral"
|
Ah, @domenic pointed me at a more up-to-date version of Live URL Viewer. Updated link in the README. |
|
@mgiuca I pushed a commit with some nits. Let me know what you think. Thanks for doing this! |
|
FTR, I also try to keep GPHemsley/WHATWG-URL up to date (for the portions of the standard I have implemented). I have Travis-CI set up to e-mail me if it starts failing any new WPT tests. |
|
@annevk Yes, those changes look fine. Sorry I forgot to reply earlier. Feel free to submit this. |
As discussed over email, there are a bunch of really helpful resources for implementors and editors which aren't findable from this repo itself.
Adds links to: