docs: add CONTRIBUTING.md with verification loop, link from CLAUDE.md - #5449
Open
johnking0099 wants to merge 1 commit into
Open
johnking0099 wants to merge 1 commit into
johnking0099 wants to merge 1 commit into
Conversation
Co-authored-by: multica-agent <github@multica.ai>
Contributor
|
I have read the CLA Document and I hereby sign the CLA Luban seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
动机
为面向开发者的贡献流程建立单一事实源(Refs MINERU-6):
方案
CONTRIBUTING.md(仓库根目录,面向人类贡献者与编码 agent 双读者):[test]/[torch]extras 的适用场景。-o addopts=""关闭默认 coverage 的说明)、解析质量改动的最小人工验证(mineru parse逐 tier +mineru-kit models)、人工检查点。Refs #n约定(引用 CLAUDE.md,无fixes #n)、PR 描述三要素(动机/方案/验证证据)。docs/next/decisions/ADR、四位递增编号规则、与专题文档的分工。验证证据
本 PR 为纯文档改动,未触碰任何代码。为确保文档中的命令真实可跑,在干净 checkout(next HEAD 317428b)上实测了全部命令(Python 3.13 +
uv pip install -e ".[test]"+ ruff 0.16.5):ruff format --check mineru tests/ruff check mineru tests:实测发现 next HEAD 全仓有大量历史违规(ANN 系列为主,约 3180 条)。因此 CONTRIBUTING.md 将 lint 门槛定为"自己的改动零新增违规",并给出用git diff --name-only圈定文件的命令,而非声称全仓 check 可作合并门槛。pytest tests/unittest/test_errors.py -q -o addopts="":7 passed。pytest tests/unittest -q -o addopts=""(无 torch extra):约 5 分 40 秒,3649 passed / 37 failed / 11 skipped。失败均为既有问题,已如实写入 CONTRIBUTING.md 的"已知基线"小节:test_mfr_latex_utils.py、test_pp_doclayoutv2_postprocess.py收集失败(缺 torch);test_render_html_table.py收集失败(依赖未在任何 extras 中声明的markdown包)。tests/unittest/test_kit_commands.py整体失败:mineru/cli_old/api_request.py:8import 的mineru.utils.backend_options模块已不存在(85021ae5 重构后遗留)。mineru parse --tier、mineru-kit models)已对照mineru/cli/commands/parse.py与mineru/kit/main.py核实。另备注两处与本 PR 无关、留待后续处理的发现:CLAUDE.md「开发环境」写的
uv pip install -e ".[core]"中coreextra 在 pyproject.toml 中并不存在(命令可执行但会落在基础依赖上);上述测试收集/既有失败清单已同步写入 CONTRIBUTING.md,避免后续贡献者误判为自己的改动引入。留待后续(不在本 PR 范围)
docs/next 各篇文档的
状态: Draft→Implemented更新依赖 MINERU-5 的文档-代码漂移审计结论,审计落地后另行提交(存在漂移的文档一律不动)。