Skip to content

Add OSS release checklist files#1217

Draft
bradygaster wants to merge 3 commits into
devfrom
bradygaster/squad-oss-release-checklist
Draft

Add OSS release checklist files#1217
bradygaster wants to merge 3 commits into
devfrom
bradygaster/squad-oss-release-checklist

Conversation

@bradygaster

@bradygaster bradygaster commented Jun 7, 2026

Copy link
Copy Markdown
Owner

Summary

Adds required files from the open-source release checklist to prepare Squad for transfer.

Changes

  • CODE_OF_CONDUCT.md — Contributor Covenant v1.4 (per GitHub template)
  • SUPPORT.md — Points users to GitHub Discussions for help
  • .github/CODEOWNERS@bradygaster @tamirdresher
  • README.md — Appended required sections: Requirements, License, Maintainers, Support, Contributing, Code of Conduct

Checklist items addressed

  • Add and update CODEOWNERS
  • Add CODE_OF_CONDUCT.md
  • Add and update SUPPORT.md
  • Update README.md to include sections from template

Copilot AI review requested due to automatic review settings June 7, 2026 01:06
@github-actions

github-actions Bot commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

🟡 Impact Analysis — PR #1217

Risk tier: 🟡 MEDIUM

📊 Summary

Metric Count
Files changed 4
Files added 3
Files modified 1
Files deleted 0
Modules touched 2

🎯 Risk Factors

  • 4 files changed (≤5 → LOW)
  • 2 modules touched (2-4 → MEDIUM)

📦 Modules Affected

ci-workflows (1 file)
  • .github/CODEOWNERS
root (3 files)
  • CODE_OF_CONDUCT.md
  • README.md
  • SUPPORT.md

This report is generated automatically for every PR. See #733 for details.

@github-actions

github-actions Bot commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

🛫 PR Readiness Check

ℹ️ This comment updates on each push. Last checked: commit 15715cc

PR Scope: 🔧 Infrastructure

⚠️ 5 item(s) to address before review

Status Check Details
Single commit 3 commits — consider squashing before review
Not in draft Ready for review
Branch up to date dev is 1 commit(s) ahead — rebase recommended
Copilot review No Copilot review yet — it may still be processing
Changeset present No source files changed — changeset not required
Scope clean No .squad/ or docs/proposals/ files
No merge conflicts No merge conflicts
Copilot threads resolved 3 unresolved Copilot thread(s) — fix and resolve before merging
CI passing 7 check(s) still running

Files Changed (4 files, +123 −0)

File +/−
.github/CODEOWNERS +4 −0
CODE_OF_CONDUCT.md +74 −0
README.md +32 −0
SUPPORT.md +13 −0

Total: +123 −0


This check runs automatically on every push. Fix any ❌ items and push again.
See CONTRIBUTING.md and PR Requirements for details.

- CODE_OF_CONDUCT.md (Contributor Covenant v1.4)
- SUPPORT.md (points to GitHub Discussions)
- .github/CODEOWNERS (@bradygaster @tamirdresher)
- README.md: add Requirements, License, Maintainers, Support, Contributing, Code of Conduct sections

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@bradygaster bradygaster force-pushed the bradygaster/squad-oss-release-checklist branch from 5245609 to 7e32973 Compare June 7, 2026 01:08

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds standard open-source readiness files (Code of Conduct, Support policy, CODEOWNERS) and appends “required sections” to the project README to align with an OSS release checklist.

Changes:

  • Added CODE_OF_CONDUCT.md (Contributor Covenant v1.4).
  • Added SUPPORT.md with guidance for issues and discussions-based support.
  • Added .github/CODEOWNERS and appended OSS-template sections to README.md (requirements, license, maintainers, support, contributing, CoC).
Show a summary per file
File Description
SUPPORT.md Adds support guidance; currently links to github/squad discussions (likely broken until transfer).
README.md Appends OSS checklist sections; contains a discussions link pointing to github/squad and a requirements inconsistency with other docs.
CODE_OF_CONDUCT.md Adds Contributor Covenant v1.4; attribution links currently use http:// (should be https://).
.github/CODEOWNERS Adds default CODEOWNERS entry for maintainers.

Copilot's findings

  • Files reviewed: 4/4 changed files
  • Comments generated: 5

Comment thread SUPPORT.md Outdated
Comment thread README.md

## Support

For help or questions about using Squad, please use [GitHub Discussions](https://github.com/github/squad/discussions). See [SUPPORT.md](./SUPPORT.md) for details.
Comment thread README.md Outdated
Comment thread README.md

## Requirements

- **Node.js** ≥22.5.0
Comment thread CODE_OF_CONDUCT.md
Comment on lines +70 to +74
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
bradygaster and others added 2 commits June 6, 2026 20:01
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@tamirdresher

Copy link
Copy Markdown
Collaborator

👋 @bradygaster — quick coordination check.

I'm planning to cut a v0.10.0 stable release this weekend (last stable was v0.9.4 on April 25; there are ~100 pending changesets in .changeset/, which work out to a minor bump per npx changeset status).

Quick questions:

  1. Are you driving a release on a different timeline (maybe tied to the OSS transfer prep here)? Happy to defer and follow your lead.
  2. If I drive it: any objection to the simple dev → main PR path (no preview branch exists), with a follow-up manual dispatch of squad-npm-publish.yml for the GITHUB_TOKEN propagation gap?
  3. The [Unreleased] section on dev still has v0.9.4 entries that never got moved — fine if I clean that up in the release PR?

Not blocking #1217 — just want to make sure we don't collide. 🖖

(Posted via Copilot CLI on Tamir's behalf, with his approval.)

@bradygaster

Copy link
Copy Markdown
Owner Author

@tamirdresher answers:

  1. no timeline yet - still some gates to get through, but, we're moving along nicely.
  2. no objection
  3. yes okay with this

No eta on this move, so, we don't need to merge this into dev. It should just be a few markdown files we can easily resolve any conflicts with later on.

@bradygaster bradygaster marked this pull request as draft June 7, 2026 07:00
tamirdresher added a commit that referenced this pull request Jun 7, 2026
…1220)

Allows tamirdresher (co-maintainer per CODEOWNERS in PR #1217) to drive
release PRs that modify CHANGELOG.md directly, matching established repo
convention (PR #1023 — chore: release v0.9.4 — was tamirdresher-authored).

Without this change, every release PR from tamirdresher requires admin
merge override on the CHANGELOG Write Protection gate (see PRs #1218,
#1219 for v0.10.0).

Co-authored-by: Tamir Dresher <tamirdresher@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.

3 participants