撰寫 Jupyter 相關學術論文的流程#
本文件描述了撰寫 Jupyter 相關學術論文的流程，這些論文通常會提交給同行評審的期刊。這不包括向會議提交的演講和海報，除非該會議也出版書面論文集。
一方面，Project Jupyter 的主要重點是生產開源軟體。我們非常專注於編寫能讓使用者滿意的程式碼。另一方面，Jupyter（和 IPython）源於學術環境，其中研究和同行評審的出版物是主要焦點。直到今天，我們的許多核心貢獻者都擁有學術職位和活躍的研究專案。這一重點也反映在 Jupyter 在所有科學研究領域的使用上。因此，儘管我們專注於為使用者編寫軟體，Jupyter 仍然是一個由研究人員開發併為研究人員服務的工具。
鑑於對研究的關注、許多 Jupyter 貢獻者持續的學術生涯，以及我們希望對計算研究產生影響的願望，撰寫和發表關於 Jupyter 本身的同行評審論文對我們來說非常重要。在一個大型開源社群的背景下撰寫這些論文，與許多研究合作相比，存在一些不同之處。
原則#
我們試圖在建立撰寫論文的流程時遵循以下一般原則：
作者身份的包容性和慷慨性。 數百名個人為不同的 Jupyter 子專案做出了貢獻。這些貢獻涵蓋了程式碼、設計、文件、討論、演講/教程等。我們希望慷慨地將作者的權利和責任擴充套件到儘可能多的貢獻者。
清晰、明確的作者資格標準。 在保持慷慨的同時，我們希望有具體、明確且可核查的標準來確定作者人選。
開放性。 撰寫論文的過程應該像專案的其他工作一樣開放。因此，我們所有的論文都在 GitHub 上公開撰寫。
問責制。 成為一篇論文的作者是一種榮幸，但也伴隨著責任。下面描述的具體流程闡明瞭這些責任。
我們期望向不同型別的期刊撰寫和提交論文。不同的期刊會有略微不同的具體流程，以適當地體現這些原則。
作者排序#
在一些學術領域，作者的排序被用來含蓄地傳達個人貢獻的水平和重要性。我們強烈認為這是誤導和錯誤的。因此，所有 Jupyter 論文將採用以下作者排序政策：
第一作者將列為“Project Jupyter”；
個人作者將按字母順序排列；並且
論文中將包含關於排序方式的明確宣告。
將第一作者列為“Project Jupyter”非常重要，因為這意味著在縮寫引用中，作者列表將是“Project Jupyter, et al.”，而不是人為地顯示按字母順序排在第一位的作者姓名。這在高能物理等擁有大量作者的學術領域是常見做法。
開源軟體期刊 (JOSS) 的流程#
開源軟體期刊（Journal of Open Source Software，JOSS）是一個經過同行評審、對開發者友好的研究相關軟體期刊。JOSS 的獨特之處在於：
每篇論文都與一個單一的 GitHub 倉庫相關聯；
主要的研究成果是軟體本身；並且
論文字身是軟體 GitHub 倉庫中一個相對簡短的 Markdown 檔案，軟體的詳細資訊則由其自身文件提供。
我們打算為我們每個主要的、面向使用者的子專案（Notebook、JupyterLab、JupyterHub、nbconvert、ipywidgets 等）發表一篇 JOSS 論文。所有此類論文都應使用本文描述的流程。
JOSS 作者資格標準#
我們的 JOSS 論文作者資格標準源自 ICMJE 的標準：
對軟體的概念、設計或實現做出重大貢獻；這包括編碼、視覺設計、文件、測試、討論及其他類似貢獻；並且
最終批准待發表的版本；並且
同意對工作的所有方面負責，確保與工作任何部分的準確性或完整性相關的問題得到適當的調查和解決。
任何滿足並願意接受這些責任和承諾的人，都歡迎成為我們任何 JOSS 出版物的作者。
JOSS 流程#
撰寫任何與 Jupyter 相關的 JOSS 論文時，應使用以下流程：
1. 有人同意擔任一篇論文的協調員#
一篇 JOSS 論文將與一個 Jupyter 倉庫相關聯。協調員通常是該專案的高階貢獻者、指導委員會成員或該子專案的負責人。
協調員的職責是為該論文執行此流程。他們不必親自撰寫 JOSS 論文，但他們將與社群合作組織論文的撰寫工作。
2. 開設一個 issue 並宣佈論文的撰寫#
協調員應在該倉庫上開設一個 issue 來組織論文的撰寫，然後向 Jupyter Google Group 宣佈該論文正在撰寫中，任何人都可以貢獻（並附上該 issue 的連結）。
3. 在倉庫中起草論文#
此時，協調員應組織實際論文的撰寫工作。
JOSS 作者指南詳細說明了 JOSS 論文的格式和要求。通常，這需要在倉庫的根目錄下建立一個 paper 子目錄，其中包含兩個檔案：paper.md 和 paper.bib。論文應使用我們標準的拉取請求和程式碼審查流程進行撰寫。
3. 透過電子郵件聯絡潛在作者#
一旦論文的最終草稿被合併到倉庫中，協調員應透過電子郵件聯絡所有潛在作者，邀請他們參與。通常這至少包括兩封電子郵件：
單獨給倉庫 Git 日誌中列出的所有貢獻者傳送電子郵件。這個列表可以使用 Git 命令
git log --all --format='%cN <%cE>' | sort -u生成。向主要的 Jupyter Google Group 傳送電子郵件，以包括未在 Git 日誌中列出的人員。
此外，協調員應向初次撰寫學術出版物的個人（如學生）傳送個人郵件，解釋我們撰寫論文的原因，並鼓勵他們參與。這些個人郵件應抄送給該個人的導師或顧問（如果適用）。
這兩類電子郵件都應包括：
上述 JOSS 作者資格標準的原樣副本；
描述每位個人需要完成哪些任務才能成為論文作者；
完成這些任務的具體截止日期（至少 2 周後）；以及
指向倉庫中論文件案的連結。
每位個人需要完成的任務如下：
在 ORCID 上建立一個賬戶。
向倉庫提交一個 PR，將他們的姓名、ORCID ID 和所屬機構新增到論文中；
對論文內容提出任何編輯建議；
在 PR 的評論中，簡要描述他們對該工作的貢獻；並且
在 PR 的評論中，確認他們已閱讀論文並同意發表。
隨著截止日期的臨近，協調員應提醒潛在作者完成他們的任務。
4. 最終提交#
一旦作者完成任務的截止日期已過，協調員應確保作者按字母順序列出。然後協調員可以提交論文。
傳統學術論文的流程#
提交給其他（非 JOSS）期刊的論文通常篇幅更長，撰寫時間也更久。它們通常會在一個專門的倉庫（在 jupyter-resources GitHub 組織下）中撰寫。由於這些因素，流程略有不同。
作者資格標準#
非 JOSS 論文的作者資格標準與 JOSS 的略有不同，因為所有作者都應積極參與論文的撰寫和編輯。
我們的論文作者資格標準源自 ICMJE 的標準：
對軟體的概念、設計或實現做出重大貢獻；這包括編碼、視覺設計、文件、測試、討論及其他類似貢獻；並且
起草作品或對其重要知識內容進行批判性修訂；並且
最終批准待發表的版本；並且
同意對工作的所有方面負責，確保與工作任何部分的準確性或完整性相關的問題得到適當的調查和解決。
任何滿足並願意接受這些責任和承諾的人，都歡迎成為我們任何出版物的作者。
第二項責任意味著所有作者都將積極參與手稿的撰寫。我們認識到，並非所有合著者對論文撰寫的貢獻都相等或方式相同。此外，對於有大量合著者的論文，我們期望主要的撰寫工作由一小部分合著者完成，其他合著者則參與編輯工作和討論。然而，在所有情況下，仍然需要以某種方式積極參與。
流程#
在為非 JOSS 論文建立詳細流程之前，我們希望先試行上述 JOSS 論文的流程，看看如何針對篇幅更長的論文進行修改。總的來說，我們期望密切遵循 SymPy 專案撰寫這篇論文時所使用的流程。