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
-
難度 1/5 1 小時以內 新手友好度 68/100
tronprotocol/tips#950 · 2 則留言 ·
-
marketing
難度 2/5 1-3 小時 新手友好度 76/100
維護者通常 1 天內回覆
-
enhancement follow-up
難度 2/5 1-3 小時 新手友好度 68/100
維護者通常 1 天內回覆
-
難度 1/5 1-3 小時 新手友好度 78/100
crosspoint-reader/crosspoint-reader#4535 ·
維護者通常 1 天內回覆
-
sweep
難度 2/5 1-3 小時 新手友好度 82/100
bketelsen/pi-pocket-team#277 ·
維護者通常 1 天內回覆