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

Add first pass at principle about designing around third-party tools #351

Merged
merged 11 commits into from
Dec 15, 2021

Conversation

LeaVerou
Copy link
Member

@LeaVerou LeaVerou commented Dec 8, 2021

(Closes #335)


Preview | Diff


Preview | Diff

Copy link
Member

@cynthia cynthia left a 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>
Copy link
Member

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"

Copy link
Member

@torgo torgo Dec 9, 2021

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"?

index.bs Outdated Show resolved Hide resolved
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.
Copy link
Member Author

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?

index.bs Outdated Show resolved Hide resolved
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,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[css-grid] ?

Copy link
Member

@torgo torgo left a 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.

index.bs Outdated Show resolved Hide resolved
Co-authored-by: Amy Guy <[email protected]>
@LeaVerou LeaVerou requested a review from cynthia December 9, 2021 11:07
@LeaVerou
Copy link
Member Author

LeaVerou commented Dec 9, 2021

I would also love to hear from @mirisuzanne before we merge, since she has been vocal but also levelheaded in the linked issue.

@cynthia
Copy link
Member

cynthia commented Dec 13, 2021

I'm wondering if we should try to make this and this #297 into a single principle, instead of writing somewhat duplicated text twice.

Copy link

@mirisuzanne mirisuzanne left a 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.

index.bs Show resolved Hide resolved
index.bs Show resolved Hide resolved
index.bs Outdated Show resolved Hide resolved
index.bs Outdated Show resolved Hide resolved
LeaVerou and others added 2 commits December 15, 2021 12:29
Co-authored-by: Sangwhan "fish" Moon <[email protected]>
Co-authored-by: Sangwhan "fish" Moon <[email protected]>
@LeaVerou LeaVerou merged commit 0e85cd4 into main Dec 15, 2021
@LeaVerou LeaVerou deleted the thirdpartytools-335 branch December 15, 2021 10:47
hober pushed a commit that referenced this pull request Apr 20, 2023
…351)

Co-authored-by: Sangwhan "fish" Moon <[email protected]>
Co-authored-by: Daniel Appelquist <[email protected]>
Co-authored-by: Amy Guy <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

New principle: Do not design around third-party tools unless it actually breaks the Web
5 participants