lincc-frameworks / lincc-frameworks/python-project-template

Option to overwrite project README when hydrating

未關閉
#588 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

enhancement
主要語言
Jinja
星號
85
分支
16
平均合併
6 小時 18 分鐘
30 天內合併 PR
1

描述

"Oh no! It does this thing where it doesn't overwrite the readme, and we do a lot of badges and things in there. We should change that," @delucchi-cmu says, while hydrating desi-aap for the incubator.

I agree--if you're hydrating a fresh github repo, there's a good chance you clicked the option to create a blank README, so it'd be really nice to have it replaced with something more useful.

貢獻指南

這個儲存庫沒有索引到貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

從模板 hydration 路徑開始,檢查如何偵測或保留現有的空白 GitHub README。完成的標準是 hydration 可以將該 README 替換為更有用的專案 README,並且預設行為和覆寫選項都有測試涵蓋。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
python
領域
developer-experience, tooling
Issue 類型
功能
難度
3/5
預估耗時
1-2 天
活躍度
冷清
描述清晰度
基本清楚
新手友好度
58/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。