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

Web Components Guidelines Doc? #227

Closed
torgo opened this Issue Jan 31, 2018 · 10 comments

Comments

Projects
None yet
5 participants
@torgo
Copy link
Member

torgo commented Jan 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.

@torgo torgo added this to the tag-f2f-tokyo-2018-04-05 milestone Feb 2, 2018

@torgo torgo self-assigned this Feb 2, 2018

@torgo

This comment has been minimized.

Copy link
Member Author

torgo commented Apr 5, 2018

Discussed at Tokyo F2F and we agreed that inputting into a document in MDN might be a better plan.

@torgo torgo removed their assignment Apr 5, 2018

@kenchris

This comment has been minimized.

Copy link

kenchris commented Apr 5, 2018

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

@torgo

This comment has been minimized.

Copy link
Member Author

torgo commented Apr 17, 2018

Kenneth to put together a strawman doc.

@travisleithead travisleithead self-assigned this May 22, 2018

@torgo

This comment has been minimized.

Copy link
Member Author

torgo commented May 22, 2018

We agreed to try to get more feedback and bump discussion to 5-29.

@kenchris

This comment has been minimized.

@kenchris

This comment has been minimized.

Copy link

kenchris commented Sep 4, 2018

Moving to TAG GitHub, as webcomponents-design-guidelines/

@JanMiksovsky

This comment has been minimized.

Copy link

JanMiksovsky commented Sep 14, 2018

@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.

@kenchris

This comment has been minimized.

Copy link

kenchris commented Sep 17, 2018

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.

@torgo

This comment has been minimized.

Copy link
Member Author

torgo commented Oct 30, 2018

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

@torgo torgo closed this Oct 30, 2018

@torgo torgo removed this from the 2018-09-18-telcon milestone Oct 30, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.