對Flake8起作用?

有很多方法可以為 Flake8 ,我們鼓勵他們:

  • 提供錯誤報告和功能請求

  • 貢獻文件(包括本文件)

  • 檢查并分類錯誤和合并請求

在你繼續說下去之前,請允許我向你保證,我確實想 your 貢獻。如果你認為你的貢獻可能沒有價值,我向你保證,你可以提供任何幫助 is 很有價值。

行為守則?

Flake8 堅持 Python Code Quality Authority's Code of Conduct . 任何違反行為準則的行為都應向伊恩?斯臺普頓?科達斯科(graffatcolmingov)報告 [at] gmail [dot] 通信)。

建立開發環境?

貢獻 Flake8 您只需要:

  • Python(我們支持的版本之一)

  • tox

    我們建議安裝如下:

    pip install --user tox
    

    python<version> -m pip install --user tox
    
  • 你最喜歡的編輯器

歸檔錯誤?

當對 Flake8 ,請填寫由提供給您的問題模板 GitLab . 如果你的bug是關于 Flake8 默認情況下報告,請不要將其報告給 Flake8 除非 Flake8 是在做什么來阻止支票運行還是你有理由相信 Flake8 抑制了檢查的有效性。

在打開新的錯誤報告之前,請搜索已關閉和打開的錯誤報告。

所有關于檢查的錯誤報告都應該轉到各自的項目:

  • 錯誤代碼以開頭 EW 應向 pycodestyle .

  • 錯誤代碼以開頭 F 應向 pyflakes

  • 錯誤代碼以開頭 C 應向 mccabe

請求新功能?

在中請求新功能時 Flake8 ,請填寫問題模板。還請注意,如果有任何現有的替代品,您的新功能,無論是通過插件,或結合命令行選項。請提供示例用例。例如,不要要求這樣的功能:

為了我的工作需要。

而是問:

我需要 Flake8 因為我的團隊希望這些文件 Flake8 目前沒有泡沫他們。我們試著用 --filename 但我們無法創造出一個有效的模式。

你解釋得越多 why 您需要一個功能,我們就越有可能了解您的需求并盡我們所能幫助您。

貢獻文件?

貢獻 Flake8 的文檔中,您可能需要先閱讀一點有關RestructedText或Sphinx的信息。 Flake8 有一個 guide of best practices 為我們的文檔提供幫助。在大多數情況下,您應該很好地遵循其余部分的結構和樣式 Flake8 的文檔。

所有的 Flake8 的文檔是用RestructedText編寫的,由Sphinx呈現。源(structuredText)位于 docs/source/ . 要以持續集成的方式構建文檔,請運行:

tox -e docs

要在本地查看文檔,還可以運行:

tox -e serve-docs

您可以在單獨的終端中運行后者,并不斷地重新運行文檔生成和刷新正在處理的文檔。

注解

我們像處理代碼一樣對文檔進行lint處理。您還應該運行:

tox -e linters

在進行更改之后,在推動它們以確保它們通過我們的CI測試之前。

貢獻代碼?

Flake8 發展發生在 GitLab . 代碼貢獻應該在那里提交。

合并請求應:

  • 解決一個問題,把它修好

    解決這個問題,但不要包括無關的重構或代碼重新格式化。換言之,保持diff的簡短,但必須盡可能短,以適當地修復錯誤并在其周圍添加足夠的測試。只要它包含的所有內容對于合并請求的目的都是必需的,那么長的差異就可以了。

  • 有描述性的標題和描述

    當合并請求得到很好的描述時,搜索舊的合并請求會變得更容易。

  • 具有遵循此樣式的提交:

    Create a short title that is 50 characters long
    
    Ensure the title and commit message use the imperative voice. The
    commit and you are doing something. Also, please ensure that the
    body of the commit message does not exceed 72 characters.
    
    The body may have multiple paragraphs as necessary.
    
    The final line of the body references the issue appropriately.
    
  • 遵循中的指南 為Flake8編寫代碼

  • 避免 .gitignore 在你的個人資料里存檔

    改變到 .gitignore 很少被接受。

    如果需要將文件添加到 .gitignore 你有多種選擇

    • 創建全局 .gitignore 文件

    • 創建/更新 .git/info/exclude 文件。

    這兩個選項都有詳細說明 here

審閱和篩選問題并合并請求?

當審查其他人的合并請求和問題時,請 尤其地 注意你所選的詞是如何被別人讀出來的。我們致力于專業的代碼審查,不侮辱貢獻者的智力或污辱他們的性格。代碼評審應該集中在代碼、代碼的有效性以及它是否適合于 Flake8 .

如果您有能力編輯問題或合并請求的標簽,請這樣做以使搜索和優先級排序更容易。

Flake8 對問題和合并請求使用里程碑。這為其他貢獻者提供有關何時傳遞問題或合并請求的指導。