clean up repo
还没有人认领这个 Issue。
- #35 来自 @adaaaam —— 已关闭,未合并
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 25/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 活跃
- 技术栈
- jupyter-notebook
调研方向
Start by reviewing the repository’s docs folder, requirements files, LICENSE, NOTICE, Makefile, and empty AUTHORS.rst. The issue raises unresolved questions about which files to remove and whether to add CONTRIBUTING and SECURITY files, and also mentions failing deploys and a README review. A clear completion point needs agreement on those decisions and the README review; no specific tests or entry points are named.
由索引模型根据 Issue 内容生成。
描述
Organization
there are files and folders that should be deleted.
we aren't using RTD for this project, so the docs folder generated from the skeleton should be deleted: https://github.com/aboutcode-org/healthycode/tree/main/docs
for a new user, a docs folder that does not include this project's docs can be confusing.
there are also three requirements files and two different license files (LICENSE is GPL-3.0, but NOTICE and the Makefile are Apache-2.0). AUTHORS.rst is empty. should we also have CONTRIBUTING and SECURITY files?
Deploys
the latest deploys are failing: https://github.com/aboutcode-org/healthycode/deployments
is there a plan to resolve this?
README
there are a lot of errors with the latest version of the README. once the above items are resolved, i can do another review to fix broken links, clarity, grammar, etc.
- 主要语言
- Jupyter Notebook
- 星标
- 1
- 派生
- 4
- 平均合并
- 1 天 17 小时
- 30 天内合并 PR
- 4
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
aboutcode-org/healthycode 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 65/100
aboutcode-org/healthycode#23 ·
-
难度 2/5 1-3 小时 新手友好度 68/100
aboutcode-org/healthycode#19 · 1 条评论 ·
-
healthycode: Document HealthyCode Deployment sizing parameters (Compute/Memory/Storage)可能已有人在做 @d4rshnn 于 10 天前认领。 未关闭
难度 4/5 3-5 天 新手友好度 52/100
aboutcode-org/healthycode#26 ·
-
难度 5/5 一周以上 新手友好度 35/100
aboutcode-org/healthycode#25 ·
-
难度 3/5 1-2 天 新手友好度 55/100
aboutcode-org/healthycode#24 ·
查看 aboutcode-org/healthycode 的全部 Issue
相似的 Issue
-
marketing
难度 2/5 1-3 小时 新手友好度 76/100
维护者通常 1 天内回复
-
难度 1/5 1-3 小时 新手友好度 78/100
crosspoint-reader/crosspoint-reader#4535 ·
维护者通常 1 天内回复
-
automated issue report
难度 1/5 1 小时以内 新手友好度 78/100
维护者通常 1 天内回复
-
self-host
难度 2/5 1-3 小时 新手友好度 70/100
funmusicplace/mirlo#2625 ·
维护者通常 1 天内回复
-
难度 2/5 半天 新手友好度 85/100
sindresorhus/eslint-plugin-unicorn#4034 ·
维护者通常 1 天内回复