Outreachy 2022 年終總結部落格
這篇部落格是關於我在 Outreachy 實習期間於 conda-forge 的工作。在那之前,先簡單介紹一下我自己 - 我是 Surbhi,是 2022 年 5 月至 8 月期間 conda-forge 的 Outreachy 實習生,我的工作是記錄 conda-forge 生態系統。
實習開始時我著手處理的第一個問題是 更好地錨定公告(#1611)。這個問題的目標是修正公告區塊中每一年和特定公告的錨點,以便提供更好的 公告頁面 導航。那時我也感到相當大的壓力與焦慮,因為我才剛開始,不確定自己是否能做到最好。但幸好有我超棒的導師 @Katherine 和 @Matt,他們總是如此樂於助人,我才能有個好的開始。我們將這個問題分成兩個部分解決。第一部分是為每一年新增錨點,已透過 改善公告區塊中每一年的錨點 (#1766) 解決,第二部分是為每一則公告新增錨點並修正 RSS 訂閱。
完成第一個問題後,我專注於文件中的 維護者文件。許多未解決的問題需要處理,才能讓維護者文件對新的維護者來說更有用且更容易存取。我們已處理的未解決問題如下:
-
記錄額外 feedstock-name (#1769) 和 說明如何成為維護者 (#1331)。已透過 新增額外章節-配方維護者和 feedstock-name (#1772) 關閉。
當我們開始改善維護者文件時,這些是我們首先挑選出來處理的問題。第一個問題是記錄維護者如何使用 "feedstock-name" 指令,以便在階段性配方中將 feedstock 命名為與其套件名稱不同的名稱。第二個問題是記錄一個人應該如何成為套件維護者。
-
在「改善文件」章節中新增更多步驟 (#1651)。已透過 更新「改善文件」章節,新增更多步驟 (#1776) 關閉。
在這個問題中,我們為想要開始貢獻 conda-forge,特別是文件方面的人們新增了一些額外步驟。
-
在文件中新增更多關於 Grayskull 的資訊 (#1655)。已透過 #1777 關閉。
文件中關於 Grayskull 的文件缺少諸如 Grayskull 究竟是什麼,以及應該如何使用 Grayskull 來產生配方等問題的答案。透過這個問題,我們為使用者新增了更多關於 Grayskull 的文件。
-
釐清 feedstock LICENSE.txt (#803)。已透過 新增 Feedstock 儲存庫結構章節 (#1786) 關閉。
關於貢獻和維護 conda 配方的文件討論了何時以及如何發布特定套件的授權。自動產生的 feedstock 儲存庫也在根目錄中包含一個授權,這與相關套件授權不同。透過這個問題,我們新增了關於這兩個授權之間差異的文件,並簡要說明了 feedstock 儲存庫結構。
-
DOC:新維護者 (#1117)。已透過 新增「regro-cf-autotick-bot 如何建立版本更新 PR?」章節。 (#1788) 關閉。
透過這個問題,我們改善了新維護者的文件和機器人的運作方式。文件中新增了「
regro-cf-autotick-bot
如何建立自動版本更新?」章節,其中說明了機器人建立自動版本更新 PR 的整個過程。 -
在文件中新增 Perl 套件提示 (#1536)。正在處理這個問題 #1790。
透過這個問題,我們在文件中新增了針對具有不同建置系統的 Perl 套件的封裝說明。
-
DOC:更新關於權杖的文件 (#1532)。已透過 #1793 關閉。
Feedstock 已停止儲存加密權杖來上傳套件,但文件中仍然存在關於權杖的過時資訊。透過這個問題,我們移除了過時的資訊,並為維護者新增了一個新的章節「如何更新您的 feedstock 權杖?」。
-
改善關於 arch_rebuild.txt 的文件 (#1668)。已透過 #1794 關閉。
透過這個問題,我們改善了關於
arch_rebuild.txt
的文件,以及如果 feedstock 需要使用不同的架構/平台(例如 ppc64le 或 aarch64)重建,維護者如何將 feedstock 新增到arch-rebuild.txt
中。 -
記錄遷移器 (#1355)、更新遷移文件 (#862) 和 記錄遷移器 (#737) 。已透過 記錄遷移器和遷移。 (#1801) 關閉。
透過這些,我們新增了更多關於遷移和遷移器的文件,這將有助於維護者找到諸如以下問題的答案 - 什麼是遷移器/遷移,它有什麼作用?他們何時可以(以及為什麼應該)拒絕遷移 PR?等等。
-
在文件中新增關於 conda-forge 安全性方面的章節 (#1808)。已透過 #1812 關閉。
目前,關於 conda-forge 建置的安全性考量資訊分散在整個文件中,因此很難找到和閱讀。透過這個問題,我們將把所有資訊放在同一個地方,這將有助於維護者和使用者更了解 conda-forge 如何保護其套件和基礎架構的安全性。
在實習期間,我遇到了一些很棒的人,他們幫助我解答了所有疑問。實習期間的經驗也幫助我在完成 Outreachy 實習後獲得更好的機會。我在實習期間學到了很多東西,如果要全部寫下來會變成一份長長的清單。但我學到最重要的東西是
- 文件的重要性以及如何撰寫好的文件。
- 撰寫文件時要遵循的最佳實務。
- 更多關於 conda-forge 和封裝工具的資訊。
最重要的是,Outreachy 幫助我對自己的技能更有信心,並克服了之前所有的冒名頂替症候群。再次感謝我超棒的導師和 conda-forge 社群的善良人們!:)