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

Addressing feedback from the AC Vote #371

Merged
merged 5 commits into from
Mar 8, 2024
Merged

Addressing feedback from the AC Vote #371

merged 5 commits into from
Mar 8, 2024

Conversation

wareid
Copy link
Collaborator

@wareid wareid commented Feb 20, 2024

Pulling together changes to reflect feedback from the AC Vote that is currently in progress.


Preview | Diff

@wareid wareid requested a review from hober February 20, 2024 16:36
@wareid
Copy link
Collaborator Author

wareid commented Feb 20, 2024

I can't seem to add Mark as a reviewer, so I'm pinging here: @mnot

@TzviyaSiegman
Copy link
Collaborator

Thank you, Wendy. This looks great.

Copy link
Member

@hober hober left a comment

Choose a reason for hiding this comment

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

The change based on my feedback looks good, so I'll hit 'Approve'. That said, the rest of the diff is quite hard to read; I suspect there are spurious whitespace / formatting changes mixed in with the substantive ones. That's unfortunate, and makes the diff as a whole hard to review.

index.html Outdated
@@ -92,6 +92,9 @@ <h3>
<h2>
Introduction
</h2>
<p class="note">
This document was formerly known as the Code of Ethics and Professional Conduct, and references to that name may still appear in other W3C documents. If there is a reference to the Code of Ethics and Professional Coduct, or CEPC, it is referring to this document.
Copy link
Member

Choose a reason for hiding this comment

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

This looks great!

@mnot
Copy link
Member

mnot commented Feb 20, 2024

Thanks, this is an improvement.

index.html Outdated Show resolved Hide resolved
Co-authored-by: Nigel Megitt <nigel.megitt@bbc.co.uk>
@wareid
Copy link
Collaborator Author

wareid commented Feb 21, 2024

The change based on my feedback looks good, so I'll hit 'Approve'. That said, the rest of the diff is quite hard to read; I suspect there are spurious whitespace / formatting changes mixed in with the substantive ones. That's unfortunate, and makes the diff as a whole hard to review.

Thank you! I need to set up the preview link for this repo, I got a little carried away with formatting.

Copy link
Member

@tantek tantek left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@fantasai fantasai left a comment

Choose a reason for hiding this comment

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

-1 to all the whitespace changes. I would welcome intentional wholesale reformatting of the source code for consistency and/or introducing semantic line breaking; but not in this PR because it's confusing. :)

Wrt the substantive changes, the Member Agreement refers to the CEPC by name (see https://www.w3.org/2023/01/Member-Agreement ) and that's a legal document, so I'm not sure it's enough to just add a historical note?

My suggestion would be to put a sentence either in the Intro or in the Status section that unambiguously says "This is the W3C Code of Ethics and Professional Conduct (CEPC)". It can also say other things, like: "This is the W3C Code of Ethics and Professional Conduct (CEPC); and has been retitled Code of Conduct for [reasons]." Or whatever.

@wareid
Copy link
Collaborator Author

wareid commented Mar 5, 2024

@chrisn Thank you for your feedback on the AC review, I have added some editorial changes in line with the feedback, would it be possible for you to review this so I can merge this PR?

@wareid
Copy link
Collaborator Author

wareid commented Mar 5, 2024

@fantasai I have addressed your suggestion in the latest commit. I cannot do anything about whitespace at this time but I will address it in a future PR dedicated to fixing all of the inconsistencies.

@swickr
Copy link
Contributor

swickr commented Mar 5, 2024

A reviewer submitted the following comments to the Team, requesting that the Team forward them. I think they have been adequately addressed in this PR, but documenting them here for the record:

Section 14 should be revisited for accessibility and inclusion as the language is not easily understandable, particularly to someone who's first language is not English. A suggested alternative follows.

  • Wasting others time.
  • Repeating statements which have been shown to be false.
  • Re-raising questions that have already been answered.

I have tested both the original text and the proposed replacement at https://app.readable.com/text/?demo. The original text is ranked as C and the replacement A.

@wareid
Copy link
Collaborator Author

wareid commented Mar 5, 2024

@swickr Thank you for sharing the feedback, I agree that I believe the comments are addressed, but just for the benefit of the submitter, I'll provide some direct pointers that are applicable to their concerns:

Wasting others time.

We don't have a specific recommendation regarding "time" as it's a challenge to quantify considering our work mode (too much time in calls? Spent reading GitHub issues?), if the reviewer has a recommendation, or would like to explore the topic further, we recommend opening an issue in this repo so we can explore it for a future revision. I think it's a worthy topic to explore, I wouldn't want to attempt to force something in without discussion.

Repeating statements which have been shown to be false.

See section 7, and point 4 of section 14.

Re-raising questions that have already been answered.

See section 14.

Re: Readability, I don't see the proposed revised text mentioned, so I'm not sure what the suggested changes are.

@fantasai
Copy link
Contributor

fantasai commented Mar 5, 2024

I cannot do anything about whitespace at this time

I'm only asking to update this PR so that it doesn't include unnecessary whitespace changes (so that it's easy to review what's actually changed). Not sure why that can't/shouldn't be done?

Copy link
Member

@tantek tantek left a comment

Choose a reason for hiding this comment

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

Updates LGTM too. Also ok with reverting the whitespace changes (presumably copy-pasting those lines from the old into additional commits on the new).

@wareid wareid merged commit 266abfb into main Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet