Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

57 lines (40 loc) · 2.83 KB

贡献指南 · Contributing

欢迎推荐项目、纠正错误或补充说明。English version below.

怎么提交

  • 推荐项目:提交 Issue,写上仓库地址和一句话说明。
  • 直接改:编辑 data/tools.yaml,把条目加到合适的分类里,然后提 PR。README 由 scripts/build_readme.py 生成,请不要直接改 README。

每个条目需要:

- repo: owner/name
  zh: "一句话中文说明:它做什么、有什么特点。"
  en: "One-sentence English description."
  mode: collab        # 可选:auto | collab | guide,只在项目 README 写明时填
  tags: [cumcm, mcm]  # 可选:cumcm | mcm | gmcm | other,项目明确支持的赛事
  skills: 3           # 可选:仓库里的 skill 数量

本地预览:

pip install pyyaml
GITHUB_TOKEN=你的token python scripts/update_stats.py   # 可选,刷新星标
python scripts/build_readme.py

收录标准

  • GitHub 上的开源项目,和数学建模竞赛或建模教学直接相关。
  • 有实质内容:能运行的代码、能安装的 skill、能用的模板或整理好的资料。
  • 说明要客观,不写“最强”“必拿国奖”之类的宣传语。
  • 工具、模板和研究类项目一年以上没有更新会标 💤(获奖论文、笔记这类内容不需要更新,不标),已归档的标 📦,链接失效的会移除。

不收录:

  • 只有产品宣传、不含源码或可用内容的仓库;
  • 作者声明私有、禁止公开传播的内容;
  • 以降 AI 率、躲避 AIGC 检测为主要卖点的工具(各赛事要求如实披露 AI 使用);
  • 比赛进行期间公开的当届题目解答。

How to contribute

  • Suggest a project: open an issue with the repository URL and one sentence about it.
  • Edit directly: add an entry to data/tools.yaml in the right category and open a PR. The README is generated by scripts/build_readme.py; please don't edit it by hand.

What gets listed

  • Open-source projects on GitHub that are directly about modeling contests or teaching modeling.
  • Real content: runnable code, installable skills, usable templates or organized study material.
  • Plain descriptions, no marketing claims.
  • Tools, templates and research projects with no update for over a year are marked 💤 (papers and notes don't need updates and aren't marked), archived ones 📦, and dead links are removed.

Not listed: product pages without source or usable content; content the author marks as private or not for redistribution; tools mainly pitched at lowering AI-detection scores (the contests require honest disclosure); solutions published while a contest is still running.