貢獻須知 - wush978/DataScienceAndR GitHub Wiki

請大家依照以下的原則做貢獻：

內容撰寫

  • 請不要抄An Introduction of R的內容到swirl之中。這本書只是參考教材，我們並不是要翻譯。我是建議大家先讀過這份文件，看一看官方文件是怎麼介紹這個Topic，並且介紹了哪些功能。這個但是在撰寫swirl課程的時候，要一直問自己放到swirl的內容：
    • 現在是不是還適合呢？
    • 可不可以再給一點範例？
    • 可不可以和R 既有的系統整合得更好？
    • 讓同學多「做」，而不是多「讀」
    • 我自己在實務上，是如何使用自己介紹的功能
  • 如果有參考其他的文件，也請讓我知道喔！

審查

  • 我們需要reviewer幫忙審查有過auto-test的課程
    • 針對PR的審查有任何意見請直接寫在該PR，方便和author交流
  • 如果是針對已經merge到course的內容有意見，請發issue

手動測試的script:

library(swirl)
delete_progress("<user>")  # 練習 swirl 的名字，Ex. wush
uninstall_all_courses()
install_course_github("發PR的<github帳戶>", "DataScienceAndR", "<branch名稱>")

例如以 pull request wush978/DataScienceAndR#34 為例，

> uninstall_all_courses()
> install_course_github("wush978", "DataScienceAndR", "pull/34/head")

版控相關技術

  • 請先fork
  • 在你的電腦上checkout branch course並進行撰寫
  • push 到你自己的repository
  • 發PR（會有自動測試來檢查你的swirl course有沒有bug），目標請先針對: dev/course
    • PR 基本上 appveyor 的測試要打勾我才會看喔！沒有打勾的話，通常代表swirl有bug，你們可以看一下CI的log來debug。如果是CI本身的bug，請發issue給我。

有任何問題，都歡迎找我hangout。

Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️