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

`darnit config migrate` drops comments in `.project/darnit.yaml`

未关闭
#524 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 2 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
54/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
活跃
技术栈
python
领域
cli, tooling

调研方向

First check whether features 040 and 042 have landed, since the issue says the behavior may differ on main until then. Read packages/darnit/src/darnit/config/operator/migrate.py and compare _write_yaml_file with the round-trip helper used by darnit.config.context_writes and update_project_config. Add the requested test; done means comments survive migration and invalid existing .project/ files are rejected with validation errors.

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

描述

interface-cli module-core quality

Applies once features 040 and 042 land (branch 042-candidate-integrity, not yet merged); until then the behaviour described may differ on main.

migrate_baseline_toml (packages/darnit/src/darnit/config/operator/migrate.py) writes .project/darnit.yaml through _write_yaml_file, which re-dumps the whole document and keeps only the leading header comment. Inline comments, comments between sections, and key formatting in an existing darnit.yaml are lost. Since feature 042, darnit.config.context_writes and update_project_config use a ruamel round-trip that preserves them (framework-design.md 7.9, FR-020).

Proposed fix: write the migrated controls: claims through the same round-trip helper, and refuse (with the validation errors) when either .project/ file is present but invalid, as the other writers do. Add a test that a commented darnit.yaml keeps its comments after darnit config migrate.

主要语言
Python
星标
22
派生
27
平均合并
2 天 18 小时
30 天内合并 PR
51

环境准备

从这里开始

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

darnitdevorg/darnit 的其他 Issue

查看 darnitdevorg/darnit 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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