Skip to content

Prepare repository for open-source release#64

Merged
lightsing merged 5 commits intodev/m2from
copilot/prepare-oss-documentation
Mar 17, 2026
Merged

Prepare repository for open-source release#64
lightsing merged 5 commits intodev/m2from
copilot/prepare-oss-documentation

Conversation

Copy link

Copilot AI commented Mar 17, 2026

Add standard OSS governance files, GitHub templates, and split licensing (MIT/Apache-2.0 for libraries, AGPL-3.0 for server components).

Licensing

  • LICENSE-MIT — full text; LICENSE-APACHE, LICENSE-AGPLplaceholders, need full text before going public
  • uts-calendar and uts-relayer Cargo.toml overridden to AGPL-3.0-only; all other crates remain MIT OR Apache-2.0 via workspace
  • Root package.json gets license field

Community docs

  • CODE_OF_CONDUCT.md — Contributor Covenant v2.1
  • CONTRIBUTING.md — dev setup, build/test/lint commands, project structure, licensing terms for contributions
  • SECURITY.md — private vulnerability reporting via GitHub Security Advisories or email, 48h ack SLA

GitHub config

  • .github/ISSUE_TEMPLATE/bug_report.yml / feature_request.yml — structured forms with component dropdown
  • .github/ISSUE_TEMPLATE/config.yml — blank issues enabled, link to docs
  • .github/PULL_REQUEST_TEMPLATE.md — description + checklist
  • .github/FUNDING.yml — custom links to calendar/relayer homepages (ETH to operator address)

README

  • CI badges, link to CONTRIBUTING.md, funding section, license section explaining the split model

Open questions

  • Should uts-stamper, uts-journal, uts-beacon-injector also be AGPL? They're runtime dependencies of the server crates.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…and README updates

- LICENSE-MIT: MIT license text
- LICENSE-APACHE: placeholder (to be updated by maintainer)
- LICENSE-AGPL: placeholder for AGPL-3.0 (calendar/relayer, to be updated)
- CODE_OF_CONDUCT.md: Contributor Covenant v2.1
- CONTRIBUTING.md: development guide and contributor guidelines
- SECURITY.md: vulnerability reporting policy
- .github/FUNDING.yml: links to calendar/relayer for ETH donations
- .github/ISSUE_TEMPLATE/bug_report.yml: structured bug report form
- .github/ISSUE_TEMPLATE/feature_request.yml: feature request form
- .github/ISSUE_TEMPLATE/config.yml: issue template config with docs link
- .github/PULL_REQUEST_TEMPLATE.md: PR description template
- Update crates/calendar and crates/relayer Cargo.toml to AGPL-3.0-only
- Update README.md with badges, license section, contributing link, funding info
- Add license field to root package.json

Co-authored-by: lightsing <15951701+lightsing@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for open source readiness Prepare repository for open-source release Mar 17, 2026
@lightsing lightsing marked this pull request as ready for review March 17, 2026 08:42
@lightsing lightsing merged commit 6699ca9 into dev/m2 Mar 17, 2026
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants