Add contributors guidelines to template

未关闭

#614 创建于 2026年2月2日 3 条评论 0 个 reaction 已指派 0 人在 GitHub 查看

还没有人认领这个 Issue。

评估

难度: 2/5
预计耗时: 1-3 小时
新手友好度: 55/100

Issue 类型: 文档
描述清晰度: 基本清楚
活跃度: 停滞
技术栈: python
领域: documentation, tooling

调研方向

Start by locating the cookiecutter package template and reviewing the linked S2FFT CONTRIBUTING.md guide as a possible model. Add a generic CONTRIBUTING.md with templated links, then verify that newly generated Python packages include the guide and that its links are appropriate for the template.

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

描述

enhancement

Is Your Feature Request Related to a Problem? Please Describe

Currently the package template does not include a CONTRIBUTING.md guidelines page, but this is quite a well suited page for templating given a basic guide can use largely pro-forma text with a few templated links. While it will need to be relatively generic, I think having something basic included by default in template would be good.

Describe the Solution You'd Like

A CONTRIBUTING.md contributors guide in the cookicutter template. We added a basic guide to S2FFT recently which could be used as starting point (as could probably many others this one is just recent in memory!).

Describe Alternatives You've Considered

No response

Additional Context

No response

主要语言: Python
星标: 62
派生: 10
平均合并: 7 天 6 小时
30 天内合并 PR: 6

贡献指南

打开贡献指南

从这里开始

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

UCL-ARC/python-tooling 的其他 Issue

Consider adding `zizmor` prek hook with GHA analysis 未关闭

enhancement investigate p3-medium

难度 3/5 1-2 天新手友好度 48/100

UCL-ARC/python-tooling#623 · 1 个 reaction · 2026年3月30日创建
Given that we are using `uv`, should the template include a `uv.lock`? 未关闭

enhancement p3-medium question task

难度 3/5 1-2 天新手友好度 38/100

UCL-ARC/python-tooling#620 · 2026年2月27日创建
Switch from MkDocs to Zensical 未关闭

task

难度 4/5 3-5 天新手友好度 25/100

UCL-ARC/python-tooling#619 · 2026年2月27日创建
Switch to `ubuntu-slim` for some jobs 未关闭

enhancement p4-low task

难度 3/5 1-2 天新手友好度 25/100

UCL-ARC/python-tooling#616 · 2026年2月5日创建
Should we drop `tox`? 未关闭

question website

难度 4/5 3-5 天新手友好度 35/100

UCL-ARC/python-tooling#599 · 3 条评论 · 2026年1月21日创建