Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Document disk export and deprecations in the changelog

未关闭 适合新手
#387 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1-3 小时
新手友好度
78/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
sqlite
领域
documentation

调研方向

从 CHANGELOG.md 开始,查看现有的发布条目,了解其简短项目符号样式。在 0.8.15 上方添加 0.9.0 部分,包含列出的每一项磁盘导出、接口、弃用项和主机要求,然后运行 pre-commit run --files CHANGELOG.md;完成的标准是所有验收标准都通过。

由索引模型根据 Issue 内容生成。

描述

DEV: dev-ops DEV: distributions DOCS: developer

Overview

The changelog describes the new disk export, the new interfaces, the deprecations, and the host requirements. This issue is part of milestone M7 (verification).

Background & Motivation

This work adds a new connection type and deprecates several public names. Hosts such as Kolibri must check their routers and change their settings to use disk export. The changelog is the place where host developers find these changes.

Design: spec. Plan: implementation plan, Task 26.

Description & Expected Outcomes

A new ## 0.9.0 section at the top of CHANGELOG.md lists the changes. Each deprecated name has its replacement next to it. The host requirements are clear enough that a Kolibri developer can act on them without the spec.

Deliverables & Contracts

The changelog contains these items:

  • DiskSyncConnection and MorangoProfileController.create_disk_connection export a fresh SQLite archive through a push.
  • Connection is an abstract interface with the Peer protocol.
  • Peer*Operation classes replace Network*Operation classes in the default settings.
  • Network<Stage>Operation is deprecated, and the replacement is Peer<Stage>Operation. The old names handle network connections only.
  • NetworkSyncConnection.server_info is deprecated, and the replacement is peer_info.
  • The server_cert= keyword is deprecated, and the replacement is peer_cert=.
  • Host routers must allow morango migrations on aliases that start with morango_archive_, and must return None from db_for_read/db_for_write for morango models. Kolibri's routers already do both.
  • Host settings overrides must list the Peer* operations for disk support.
Acceptance Criteria
  • CHANGELOG.md has a ## 0.9.0 section above ## 0.8.15.
  • The section contains every item in the list of deliverables.
  • pre-commit run --files CHANGELOG.md passes.

Technical Pointers & Architecture

  • Target Components / Context: CHANGELOG.md.
  • Related Patterns: The existing release entries in CHANGELOG.md use one short bullet per change.
  • Data Model & Schema Considerations: The entry can mention the new ArchiveManifestEntry table, which is empty in host databases.
  • Resilience & Failure Modes: None.

Notes & Tradeoffs

  • Dependencies: Blocked by: #386 (parity and end-to-end tests). Blocks: none.
  • Compatibility & Migrations: The spec leaves open the release that removes the deprecated names. Removal requires the Kolibri companion changes in spec §3.9.

Metadata

  • Complexity: Low
  • Target Branch: release-v0.9.x

AI Usage

Drafted with Claude (Claude Code) from the approved design spec and implementation plan. The author reviewed the requirements, and the code references were checked against the release-v0.9.x codebase.

主要语言
Python
星标
15
派生
23
平均合并
1 天 11 小时
30 天内合并 PR
4

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

learningequality/morango 的其他 Issue

查看 learningequality/morango 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。