Skip to content

Contributor setup: Code of Conduct, templates, All Contributors - #214

Merged
MehdiMamas merged 3 commits into
mainfrom
contrib-202
Nov 14, 2026
Merged

MehdiMamas merged 3 commits into
mainfrom
contrib-202

Conversation

@MehdiMamas

Copy link
Copy Markdown
Owner

Part of #199. Closes #202.

What: Contributor Covenant 2.1, bug and feature issue forms (blank issues off, Discussions and private security links), PR template, All Contributors config and a Contributors section in the README, pointers in CONTRIBUTING and SECURITY.

Settings done outside the diff: Discussions on, private vulnerability reporting on, 8 starter issues filed (#206 to #213), help wanted on #197.

Checks: each template parsed with a YAML parser; docs only, no code.

Left for the maintainer: install the All Contributors GitHub App on the repo.

…ontributors config

Before: no Code of Conduct, templates or contributor list; CONTRIBUTING did not mention Discussions or good first issues.
Now: Contributor Covenant 2.1, bug and feature forms, PR template, .all-contributorsrc and a Contributors section, CONTRIBUTING and SECURITY pointers.
@MehdiMamas

Copy link
Copy Markdown
Owner Author

Check:

  • pass: given the private vulnerability reporting API is not enabled -> enable it and verify it returns enabled true before SECURITY.md points to it — API returned enabled true; SECURITY.md:6
  • pass: given an issue template with a YAML mistake -> GitHub ignores it, so parse every template with a YAML parser before pushing — all three parsed with yaml.safe_load, .github/ISSUE_TEMPLATE/
  • pass: given a starter issue that names a private repo or a local path -> never filed; each body is checked for both — bodies reviewed, only public paths in Install script for claude-sync-cli on Windows (PowerShell) #206 to Add the app to the Windows package manager #213
  • pass: given the Discussions toggle fails -> report it, do not claim done — has_discussions returned true
  • pass: given the All Contributors app is not installed -> README table is valid and the bot step is handed to the owner — README.md Contributors section, .all-contributorsrc

Checkpoint: commit 0c7398d on branch contrib-202, PR 214 open and waiting for CI. Discussions and private reporting are on, starter issues are #206 to #213. Left: merge the PR, then the owner installs the All Contributors app.
ETA: about 10 minutes, waiting on CI.

@MehdiMamas

Copy link
Copy Markdown
Owner Author

Diff review:

  • .github/ISSUE_TEMPLATE/bug_report.yml:22 tells users to run claude-sync status. The binary is claude-sync-cli (crates/cli/Cargo.toml), so that command does not exist. status does not print the version either. The version command is claude-sync-cli version (crates/cli/src/cmds.rs:75). Change the text to that. Also check that Settings really shows the version.
  • CODE_OF_CONDUCT.md Enforcement section: the Plan says contact is via the private Security advisory form. The diff sends reports to the email in SECURITY.md. That is a deviation from the Plan. A CoC report is not a vulnerability, so the email may be the better choice, but the PR body does not say it was deliberate.
  • README.md Contributors section: the Plan says a Contributors table. The diff has only empty ALL-CONTRIBUTORS-LIST markers, so nothing shows until the bot runs. The PR body's "Left for the maintainer" covers the app install but not this.
  • SECURITY.md:7 already told people to use Report a vulnerability. The Plan's pointer step only added a parenthetical. Fine, but it is not a new pointer.

No security or cost problems. I checked that the labels bug and enhancement exist and that #206 to #213 carry good first issue or help wanted labels.

@MehdiMamas

Copy link
Copy Markdown
Owner Author

Check:

  • pass: given the private vulnerability reporting API is not enabled -> enable it and verify it returns enabled true before SECURITY.md points to it — API returned enabled true; SECURITY.md:6
  • pass: given an issue template with a YAML mistake -> GitHub ignores it, so parse every template with a YAML parser before pushing — all three parsed with yaml.safe_load, .github/ISSUE_TEMPLATE/
  • pass: given a starter issue that names a private repo or a local path -> never filed; each body is checked for both — bodies reviewed, only public paths in Install script for claude-sync-cli on Windows (PowerShell) #206 to Add the app to the Windows package manager #213
  • pass: given the Discussions toggle fails -> report it, do not claim done — has_discussions returned true
  • pass: given the All Contributors app is not installed -> README table is valid and the bot step is handed to the owner — README.md Contributors section, .all-contributorsrc

Checkpoint: commit 0c7398d on branch contrib-202, PR 214 open and waiting for CI. Discussions and private reporting are on, starter issues are #206 to #213. Left: merge the PR, then the owner installs the All Contributors app.
ETA: about 10 minutes, waiting on CI.

@MehdiMamas

Copy link
Copy Markdown
Owner Author

Diff review:

  • Earlier finding fixed: .github/ISSUE_TEMPLATE/bug_report.yml:22 now says claude-sync-cli version, which matches crates/cli/src/cmds.rs:75 and the binary name in crates/cli/Cargo.toml. The Settings claim ("You have version ...") matches app/ui/src/screens/settings.ts:33.
  • .github/ISSUE_TEMPLATE/bug_report.yml:22: that Settings line only shows when no update is available (settings.ts:28-33). If an update is pending, the user sees "Version X is ready/downloading" and not the installed version. Minor: reword to "or Settings when it says 'You have version ...'", or accept it.
  • CODE_OF_CONDUCT.md Enforcement: the Plan says contact is via the private Security advisory form. The diff uses the SECURITY.md email. This is still a deviation, and the PR body does not say it was deliberate. Either switch it or add a line to the body.
  • README.md Contributors section: the Plan says a Contributors table. The diff has only empty ALL-CONTRIBUTORS-LIST markers, and contributors is []. Nothing renders until the app is installed and a first add runs. The PR body's "Left for the maintainer" does not say this.
    No security or cost problems. Labels bug and enhancement exist.

@MehdiMamas
MehdiMamas merged commit d8af927 into main Nov 14, 2026
3 checks passed
@MehdiMamas
MehdiMamas deleted the contrib-202 branch November 14, 2026 08:09
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.

Launch 3/5: contributor setup (CoC, templates, labels, starter issues, All Contributors, Discussions)

1 participant