#227: Web Components Guidelines Doc?
Discussions
Comment by @torgo Apr 5, 2018 (See Github)
Discussed at Tokyo F2F and we agreed that inputting into a document in MDN might be a better plan.
Comment by @kenchris Apr 5, 2018 (See Github)
There is a Gold Standard here with a lot of good points: https://github.com/webcomponents/gold-standard/wiki
Rob Dodson also wrote a few documents: https://github.com/webcomponents/webcomponents.github.io/wiki/BestPractices http://robdodson.me/interoperable-custom-elements/
Also, https://github.com/mateusortiz/webcomponents-the-right-way
We might be able to turn this into a nice MDN article and also ask for feedback from the Ionic/Stencil team
Comment by @torgo Apr 17, 2018 (See Github)
Kenneth to put together a strawman doc.
Discussed
May 1, 2018 (See Github)
@kenneth: Postponed until I got a bit more feedback.
@travisleithead: I would like to take a look and give some feedback.
@torgo: Me too. Bumped until 29th.
Comment by @kenchris May 22, 2018 (See Github)
Comment by @torgo May 22, 2018 (See Github)
We agreed to try to get more feedback and bump discussion to 5-29.
Discussed
Aug 1, 2018 (See Github)
KC: I have some new text, just need to put it back into the doc.
Discussed
Sep 1, 2018 (See Github)
Kenneth: i want to move this to a more proper place.
Hadley: mdn artifcle?
Hey:Kenneth: it's a spec like thing - rather than an article.
Hadley: turn it into a note?
Peter: we have other things like the API design guidelines document - which we are just publishing on github [ta\g] We can host it on tag.w3.org - we can publish a finding or note.
Kenneth: Relative difference in standing between them?
Dan: I think a finding has more weight because TAG publishes findings, but NOTEs generally don't. But NOTEs have more process around them than finding so maybe has more standing. I think should be more like promises guide or API design guidelines -- something that's more fluid. We could then decide to takesnapshots. I think we should publish like we published the promises guide.
Kenneth: repo?
Dan: I think youshould beaould be able to make a repo on TAG github yourself; if cannot ping Peter.
Peter: OK, Kenneth will make a repo, and people need to start reviewing and giving feedback.
Kenneth: People read at face-to-fcae, but more review is good. Name web components guidelines ok for repo?
Alex: Web Components design guidelines?
Peter: sounds fine
Peter: Everyone can review, come back in 2 weeks
Comment by @kenchris Sep 4, 2018 (See Github)
Comment by @kenchris Sep 4, 2018 (See Github)
Moving to TAG GitHub, as webcomponents-design-guidelines/
Comment by @JanMiksovsky Sep 14, 2018 (See Github)
@kenchris Was just made aware of this thread by @slightlyoff. Depending on your goals and plans, we'd probably like to be involved in helping draft guidelines for web components. Can you elaborate a bit on those, either here or in mail to jan@component.kitchen?
We wrote the Gold Standard checklist in early 2015 and tried at that point to solicit help fleshing out the list, solidifying the recommendations, and promoting those guidelines — but found very few people who were interested in the topic and willing to actually help. It appears there's more interest now.
Comment by @kenchris Sep 17, 2018 (See Github)
Hi there @JanMiksovsky - we already made some recommendations that were reviewed by the TAG team.
You can find the live document here: https://w3ctag.github.io/webcomponents-design-guidelines/ and files issues and ideas here: https://github.com/w3ctag/webcomponents-design-guidelines/issues
The goal was to create some guidelines on how to construct web components in such a way that they could later be adopted by standards (ie. merged into HTML spec with non-hyphenated name).
We also linked to the Goal Standard in the document :-) Any comments and PR's are welcome.
Comment by @torgo Oct 30, 2018 (See Github)
We've done this and published a finding. New issues can be registered in the issues list for that doc here: https://github.com/w3ctag/webcomponents-design-guidelines/issues
OpenedJan 31, 2018
Should the TAG work on a web components design documentation? Could we make use of existing community-developed best practices? Do we have enough useful thinking on this topic to write something that would be useful to the wider community? This issue is intended to collect ideas and feedback on this topic.