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

doc: add code of conduct prefix text #991

Merged
merged 3 commits into from
Jan 24, 2023

Conversation

anonrig
Copy link
Member

@anonrig anonrig commented Jan 4, 2023

For future tracking here's the steps taken/will be taken for the patching script:

This pull request includes the initial changes required to have a patching script for the CoC template. The patching script basically get's a commit SHA, and appends the original CoC template (available from code covenants website), and later applies the patching file (which will be included in the next pull request adding the script).

Steps needed to take to add the patching script:

  1. Add a PREAMBLE file containing only the first portion of CoC
  • This pull request copies the first portion, and later applies changes only required to make sense in this context. (Removing some links and adding context to CoC modifications)
  1. Add a patching script (a different pull request)
  • Update the base_url on the patch script with the URL of the SHA commit from this pull request to use it as a baseline.
  • Remove the CODE_OF_CONDUCT.md
  • Generate an initial patching file required to have the current version of CODE_OF_CONDUCT.md with minimal changes.
  • Push it to the patching script.

Co-authored by @joesepi

@bnb
Copy link
Member

bnb commented Jan 4, 2023

can you describe what you mean by "prefix"? 🤔

Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

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

LGTM

@ljharb
Copy link
Member

ljharb commented Jan 4, 2023

I read it to mean that the CoC content will be appended after the prefix text.

@bnb
Copy link
Member

bnb commented Jan 4, 2023

if that is the case, we probably want to change the wording in the first section to reflect that we use a modified version and that the translations are available but don't reflect the modified version, right?

conduct/artifacts/CODE_OF_CONDUCT_PREFIX.md Outdated Show resolved Hide resolved
conduct/artifacts/CODE_OF_CONDUCT_PREFIX.md Outdated Show resolved Hide resolved

## Escalate an issue

The OpenJS Foundation maintains a [Code of Conduct Panel (CoCP)](https://github.com/openjs-foundation/cross-project-council/blob/HEAD/conduct/FOUNDATION_CODE_OF_CONDUCT_REQUIREMENTS.md#code-of-conduct-panel). This is a foundation-wide team established to manage escalation when a reporter believes that a report to a member project or the CPC has not been properly handled.
Copy link
Member

Choose a reason for hiding this comment

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

Potentially want to clarify here that this isn't meant to duplicate the above section on reporting an issue in a project. On first read, that wasn't clear to me and I've been involved in this stuff for a long time - I imagine it might be even less clear to people who aren't familiar with this.

Copy link
Member Author

Choose a reason for hiding this comment

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

The recommendation was ambiguous (for a non-native speaker like me). If you're concerned and have a specific recommendation, can you add this to this review, or can we do it in a different pull request?

Copy link
Member

Choose a reason for hiding this comment

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

this is unresolved but shouldn't block merging.

Copy link
Contributor

@tobie tobie left a comment

Choose a reason for hiding this comment

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

I'm confused about whether this PR is changing the content of the CoC or just moving it around and trimming the imported part.

If it's the latter I suggest having two separate commits, one that moves the CoC, and the other one that amends it, so it it clear what's going on. (And if that's what the PR is about, then we shouldn't be editing the language of the CoC intro in this PR).

@tobie
Copy link
Contributor

tobie commented Jan 4, 2023

@bnb wrote:

can you describe what you mean by "prefix"? 🤔

I think we should rename this file to CODE_OF_CONDUCT_PREAMBLE.md or CODE_OF_CONDUCT_INTRO.md. That would be clearer.

@joesepi joesepi mentioned this pull request Jan 5, 2023
Co-authored-by: Joe Sepi <sepi@joesepi.com>
@anonrig
Copy link
Member Author

anonrig commented Jan 17, 2023

I created two commits, the first moving the file and the second making the changes. After the meeting, I'll update the changes and re-request for reviews. Thank you for all the patience in the review of this pull request.

@anonrig
Copy link
Member Author

anonrig commented Jan 17, 2023

I think we should rename this file to CODE_OF_CONDUCT_PREAMBLE.md or CODE_OF_CONDUCT_INTRO.md. That would be clearer.

@tobie I've changed the naming of the file. Thank you for the suggestion!

Co-authored-by: Joe Sepi <sepi@joesepi.com>
Copy link
Contributor

@tobie tobie left a comment

Choose a reason for hiding this comment

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

Thanks for those changes. This is super helpful. As discussed in the call, it would be great if we had a summary in the body of the commit of why we're adding the COC_PREAMBLE rather than moving the COC.

@anonrig
Copy link
Member Author

anonrig commented Jan 17, 2023

Thanks for the review. I've updated/added a description for this pull request. I hope it clarifies a couple of things. @tobie

@anonrig anonrig requested a review from bnb January 17, 2023 17:33
@joesepi joesepi merged commit 9a4beb1 into openjs-foundation:main Jan 24, 2023
@anonrig anonrig deleted the artifact-coc branch January 24, 2023 18:00
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.

None yet

9 participants