-
Notifications
You must be signed in to change notification settings - Fork 49
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
Add first pass at principle about designing around third-party tools #351
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think one important comment I'd like to leave here is that the title should be a suggestion. Additionally, we try to make the first sentence (ideally) or paragraph guidance on what we expect from the spec authors, but that happens quite late in this section. I think this can be shrunk down a bit and re-ordered to be consistent with the rest of the document.
index.bs
Outdated
@@ -805,6 +805,57 @@ and doing cleanup as necessary (see above). | |||
is still [under discussion](https://github.com/whatwg/html/issues/6588). | |||
</div> | |||
|
|||
<h3 id="third-party-tools">Handling conflicts with third-party tools</h3> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should be consistent in tone with the rest of the document. e.g. "Ensure x with third-party tools"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Avoid Designing Around Conflicts with Third Party Tools"?
"Priotise Ussability over Compatibility with Third Party Tools"?
Co-authored-by: Sangwhan "fish" Moon <[email protected]>
<div class="example"> | ||
When the CSS WG was designing Grid, | ||
square brackets were chosen instead of parentheses for naming grid tracks | ||
to avoid breaking Sass, a popular preprocessor. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@plinss You mentioned this example, any chance you have a source that we should point to?
Co-authored-by: Daniel Appelquist <[email protected]>
index.bs
Outdated
it is usually preferable to prioritize the ones that inconvenience third party tools the least. | ||
|
||
<div class="example"> | ||
When the CSS WG was designing Grid, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[css-grid]
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me.
Co-authored-by: Amy Guy <[email protected]>
I would also love to hear from @mirisuzanne before we merge, since she has been vocal but also levelheaded in the linked issue. |
I'm wondering if we should try to make this and this #297 into a single principle, instead of writing somewhat duplicated text twice. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this all makes sense, balancing the various tradeoffs/concerns that need to be taken into account.
Co-authored-by: Sangwhan "fish" Moon <[email protected]>
Co-authored-by: Sangwhan "fish" Moon <[email protected]>
…351) Co-authored-by: Sangwhan "fish" Moon <[email protected]> Co-authored-by: Daniel Appelquist <[email protected]> Co-authored-by: Amy Guy <[email protected]>
(Closes #335)
Preview | Diff
Preview | Diff