docs: adopt Contributor Covenant 3.0 for the Code of Conduct - #624
Merged
Merged
Conversation
Requested by the maintainer: "for COC, let's use the latest version? i see it at 3.0 already". `CODE_OF_CONDUCT.md` was Contributor Covenant 1.4, whose rendering #613 repaired while deliberately leaving the version alone. - The text is the canonical 3.0 Markdown, fetched from https://www.contributor-covenant.org/version/3/0/code_of_conduct/code_of_conduct.md and diffed against what is committed, rather than transcribed. Our Pledge, Encouraged Behaviors, Restricted Behaviors and Scope are unaltered, upstream typographic quirks included. - 3.0 ships two `[NOTE` placeholders an adopter must fill. The reporting channel now names `jarryshaw@icloud.com`, the contact 1.4 already carried and the one `SECURITY.md` names as its email fallback, plus GitHub's report-abuse form for the case a solo project otherwise cannot cover -- a report about the maintainer. The enforcement placeholder is an instruction to the adopter and is removed. A sentence sends security reports to `SECURITY.md` instead, so the two documents do not appear to share a channel. - 3.0 assigns enforcement to plural "Community Moderators" (and once, inconsistently, "Community Managers"). This repository has one maintainer, so all eight occurrences are singular now, and the reporting section says plainly that there is no moderation team and that response is best-effort. The four-rung ladder is kept: each rung maps onto a lever one person holds on GitHub -- a private message, a locked thread, an interaction limit, a permanent block. - 3.0 is CC BY-SA 4.0, where 1.4's attribution paragraph carried no licence notice at all. The attribution names version 3.0, links the permanent `version/3/0/` URL, carries the CC BY-SA 4.0 notice and link, indicates that changes were made as BY requires, and confines share-alike to this document. `LICENSE` is untouched and the code stays BSD-3-Clause. Changelog entry added to `docs/source/changelog/1.5.0.rst`; `CHANGELOG.md` regenerated with `python util/changelog_md.py` and `--check` exits 0. Rendering verified through GitHub's Markdown API -- the ladder comes back as four list items each nesting three, not the single collapsed item #613 had to fix. No tests run: nothing here touches the package.
JarryShaw
force-pushed
the
coc-contributor-covenant-3.0
branch
from
September 22, 2026 03:31
7078599 to
b7eb336
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by the maintainer — "and for COC, let's use the latest version? i see it at 3.0 already". No issue tracks this.
CODE_OF_CONDUCT.mdwas Contributor Covenant 1.4. #613 repaired its rendering and deliberately left the version alone, because that was the maintainer's call; it has now been made.The text is fetched, not transcribed
The base is the canonical 3.0 Markdown from https://www.contributor-covenant.org/version/3/0/code_of_conduct/code_of_conduct.md, diffed against what is committed here. Note the
.mdlink the 3.0 page advertises is the nested one above —…/version/3/0/code_of_conduct.md404s.Our Pledge, Encouraged Behaviors, Restricted Behaviors (and Other Restrictions), and Scope are byte-identical to upstream, including two upstream typographic quirks left alone rather than tidied: the period outside the bold in
**Violating confidentiality**.and**Promotional materials**., and the curly apostrophes in "anyone’s" and "Mozilla’s".Everything that differs from canonical is one of the following, and nothing else:
[NOTE#1 filled — reporting channelSECURITY.md[NOTE#2 removed — it is an instruction to the adopter, not document textThe two
[NOTEplaceholders3.0 ships two, which the Contributor Covenant site tells adopters to find by searching for
[NOTE. Shipping either one unfilled would have been worse than staying on 1.4.Reporting channel. Upstream reads
To report a possible violation, **[NOTE: describe your means of reporting here.]**. It now namesjarryshaw@icloud.com— the same working contact 1.4 carried, and the oneSECURITY.mdalready points at as its email fallback — asks forCode of Conductin the subject and links to the material involved, and adds GitHub's report abuse form for the case a solo project structurally cannot cover: a report about the maintainer. 1.4 papered over that with "other members of the project's leadership", who do not exist.Enforcement process. Upstream's second placeholder is a bracketed instruction to the adopter ("be sure to edit this section to describe your own policies"), not prose for readers. It is removed, and the section is edited as it invites.
"Community Moderators", and the four-rung ladder
3.0 assigns enforcement throughout to a plural moderation team that this repository does not have — and once, inconsistently in the upstream text itself, calls them "Community Managers". All eight occurrences are now the singular maintainer, and the reporting section says plainly that there is no moderation team and no rota and that response is best-effort rather than contractual, which matches what
SECURITY.mdalready says. Upstream's investigation methods ("reviewing messages, logs, and recordings, or interviewing witnesses") are adapted to what a GitHub project actually has: the issue, pull request, commit and message history, and asking those involved for their account.The four-rung ladder is kept, and the document now says why: each rung maps onto a lever one person genuinely holds on GitHub — a private message, a locked or limited thread, a temporary interaction limit or block, a permanent block reported to GitHub. Keeping it was the judgement call; a ladder a solo maintainer could not operate would have been the same kind of fiction as the committee.
CC BY-SA 4.0
This is a new obligation — 1.4's attribution paragraph in the old file carried no licence notice at all. The attribution now names Contributor Covenant 3.0, links the permanent
https://www.contributor-covenant.org/version/3/0/URL, carries the CC BY-SA 4.0 notice and link, and adds a "Changes were made" paragraph naming which sections were modified, which BY requires and upstream's template does not supply.One sentence confines it: "That license covers this document only. The
pcapkitsource code is separately licensed under BSD-3-Clause; seeLICENSE."LICENSEis not touched by this PR (it is #615's file, now merged), and nothing here changes the code's licence. A CC BY-SA governance document alongside BSD-3-Clause code is ordinary and is not a conflict.Consistency with
SECURITY.mdChecked, and they agree — but only just, so the seam is now explicit in both directions:
SECURITY.md:34-36tells a reporter who cannot use a private advisory to "email the project contact listed inCODE_OF_CONDUCT.md". That cross-reference depends on this file carrying an email address, which is an independent reason the contact had to survive the upgrade.SECURITY.md.SECURITY.mdis unmodified.Stale 1.4 references
Swept the tree for
conduct,covenant,version/1/4andconduct.md. The only file naming version 1.4 or linking the1/4URL wasCODE_OF_CONDUCT.mditself, so nothing outside it went stale.CONTRIBUTING.md:84mentionsCODE_OF_CONDUCT.mdonly as a filename in the list of root Markdown files, with no version reference; nothing underdocs/source/,pyproject.toml,.github/or the README mentions the Code of Conduct at all. No corrections were needed in any file another PR owns,docs/source/index.rstincluded.Rendering
The 1.4 file's defect in #613 was structural — a stray
1.marker collapsing the whole document into one nested list item — so rendering was verified rather than assumed. Run through GitHub's own Markdown API (POST /markdown,mode=gfm): one<h1>, seven<h2>, and the ladder as a four-item<ol>each containing a nested three-item<ol>inside its<li>. The1)delimiter and three-space continuation indent that canonical 3.0 uses are kept verbatim and render correctly.Changelog
Bullet added to
docs/source/changelog/1.5.0.rst;CHANGELOG.mdregenerated withpython util/changelog_md.py, never hand-edited, and--checkexits 0.Worth flagging: #613 argued the opposite for its own CoC change — "No changelog entry: contributor-facing documentation, not user-visible". A bullet is included here because a version change alters the governance terms and adds a licence notice a downstream inventory may care about, which the rendering repair did not. Reverse it if you disagree.
Not done
pcapkitimport — nothing here touches the package.CONTRIBUTING.mdstill does not mention the Code of Conduct as something contributors agree to, only as a file that is exempt from the.rstrule. Out of scope for a version bump, andCONTRIBUTING.mdwas refreshed recently by docs: repair the Code of Conduct's rendering and refresh CONTRIBUTING #613.