Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝Editorial: Update resources/README.md #8140

Merged
merged 2 commits into from
Nov 24, 2017

Conversation

snuggs
Copy link
Contributor

@snuggs snuggs commented Nov 10, 2017

Make prose for resources more friendly to new adopters. (i.e., testharness.js).

I have been educating the community on the benefits of aligning testing
with WPT. However, testharness is a little difficult to get head wrapped around
from the feedback I am receiving. Also have recently been doing some prose
updates in documentation over @ WHATWG. I am revisiting the WPT setup process
and believe one should always leave code better than when they saw it.

If this is not of value please let me know the best way to contribute to improving documentation.

🙏

References:


This change is Reviewable

Improve prose for resources (i.e., `testharness.js`).

I have been educating the community on the benefits of aligning testing
with WPT. However, testharness is a little difficult to get head wrapped around
from the feedback I am receiving. Also have recently been doing some prose
updates in documentation over @ WHATWG. I am revisiting the WPT setup process
and believe one should always leave code better than when they saw it.

References:
  - whatwg/meta#48
  - (in particular) whatwg/meta#48 (comment)
@w3c-bots
Copy link

w3c-bots commented Nov 10, 2017

Build PASSED

Started: 2017-11-10 02:04:03
Finished: 2017-11-10 02:09:03

View more information about this build on:

@snuggs snuggs changed the title Editorial: Update README.md Editorial: Update reasources/README.md Nov 10, 2017
@snuggs snuggs changed the title Editorial: Update reasources/README.md 📝Editorial: Update reasources/README.md Nov 10, 2017
@jgraham
Copy link
Contributor

jgraham commented Nov 10, 2017

I think the titles should ideally all be in title case, but sure we can merge this.

@snuggs
Copy link
Contributor Author

snuggs commented Nov 10, 2017

@jgraham titles ARE in title case. Headers are not.
# title

#(n) header

I referenced this multiple times above...
whatwg/meta#48 (comment)
And went into detail here whatwg/meta#50 (comment)

@snuggs snuggs changed the title 📝Editorial: Update reasources/README.md 📝Editorial: Update resources/README.md Nov 10, 2017
@snuggs
Copy link
Contributor Author

snuggs commented Nov 10, 2017

CI appears to be stuck... @jgraham @gsnedders

@snuggs
Copy link
Contributor Author

snuggs commented Nov 12, 2017

OK CI cleared @jgraham @gsnedders

@gsnedders
Copy link
Member

@snuggs FWIW, we don't necessarily follow WHATWG policies here.

@gsnedders gsnedders merged commit 589f2e2 into web-platform-tests:master Nov 24, 2017
@snuggs snuggs deleted the patch-1 branch November 25, 2017 02:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants