參與開發

歡迎參與開發，並對此表達誠摯感謝！只要一點點貢獻都是好的，我們絕不會忘記您的付出。

有多種方式可以參與開發

開發類型

回報錯誤

在 https://github.com/sknetwork-team/sknetwork/issues 回報錯誤。

如果您要回報錯誤，請包含下列資訊：

  • 您的作業系統名稱和版本。

  • 任何可能有助於解決問題的關於您本地端設定的詳細資料。

  • 重現這個錯誤的詳細步驟。

修正錯誤

在 GitHub 的問題中尋找錯誤。任何標記為「錯誤」和「急需協助」的錯誤開放給任何想要實作它的人。

實作功能

查看 GitHub 專案。在專案中列出的任何內容都是待實作的功能。

您也可以在 GitHub 問題中查看功能。任何標記為「增強」和「急需協助」的功能開放給任何想要實作它的人。

編寫文件

scikit-network 永遠可以再加入文件，無論是作為作為 scikit-network 官方文件的一部分、寫在文件字串、甚至是發表在部落格、文章和類似文章中的網路文件。

提交回饋

在 https://github.com/sknetwork-team/sknetwork/issues 提交問題或在 https://github.com/sknetwork-team/scikit-network/discussions 發起討論是傳送回饋的最佳方式。

如果您準備提案一個功能

  • 詳細說明它如何運作。

  • 維持範圍盡可能狹窄，如此一來更容易實作。

  • 請記住，這是一個志工推動的專案，並且歡迎大家共襄盛舉 :)

開始動作！

準備好做出貢獻了嗎？以下是設定 sknetwork 進行本機開發的方式。

  1. 分岔 sknetwork 在 GitHub 上的儲存庫。

  2. 複製你的分岔到本機

    $ git clone git@github.com:your_name_here/sknetwork.git

  3. 將你的本機副本安裝到一個 virtualenv 中。假設你有安裝 virtualenvwrapper，這是你如何設定你的分岔進行本機開發的方式

    $ mkvirtualenv sknetwork
$ cd sknetwork/
$ python setup.py develop

  4. 建立一個用於本機開發的分支

    $ git checkout -b name-of-your-feature

    現在你可以在本機進行變更了。

  5. 在你完成變更後，檢查你的變更是否通過 flake8 和程式測試，包括使用 tox 測試其他 Python 版本

    $ flake8 sknetwork tests
$ python setup.py test or py.test
$ tox

    取得 flake8 和 tox，只要使用 pip 將他們安裝到你的 virtualenv 中即可。

  6. 提交你的變更並將你的分支推送到 GitHub 上

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-feature

  7. 透過 GitHub 提交拉取請求。

拉取請求指南

在你提交拉取請求前，請先確認已經符合這些指南

  1. 拉取請求應該納入程式測試。

  2. 如果拉取請求增加了功能，文件就應該要更新。將你的新功能放入一個帶有文件字串的函數中，並將功能新增到 README.rst 中的清單內。

  3. 拉取請求應該能用於 Python >= 3.8

可以在 Wiki 的「共襄盛舉指南」中找到更完整的指導方針，提供說明如何為此套件撰寫程式碼。

提示

執行部分測試

$ py.test tests.test_sknetwork

別猶豫，前往 Wiki 查看資訊。