Skip to content

代碼提交要求

第一點,也是最重要的一點——

你應該提交好的代碼,但是你可以根據自己的內心決定什麼樣的代碼風格是好的。

遵守通用的代碼規範

比如,在你編寫Python代碼的時候,應當遵守PEP-8(https://alvin.red/2017/10/07/python-pep-8/)的要求。

當然這是在不違背第一點的前提下。我的意思是,如果你在某一個點上覺得「這樣也行那樣也行」,那就按PEP-8來吧。

關於中文命名

因爲我喜歡中文,所以項目裏有很多中文標識符。

你可以按一般的習慣使用英文命名,建議使用下劃線命名法。但是不要用英文寫註釋。

也可以使用中文命名,如果你習慣打簡體字也可以,我們也許會計劃什麼時候把這個項目的代碼統統改成簡體字。

Git的注意事項

我們使用Git做版本控制。

不要把代碼直接提交到master分支,你要新建一個分支來做自己添加的修改,然後再合併回去。
比如說我要添加蘿莉色圖自動生成功能,我就先新建一個分支,叫做「加色圖」,在這個分支上commit了幾次以後,最後將「加色圖」與master分支合併。

commit信息應當填寫中文,儘量能把做了什麼說清楚,不要填寫「喵喵喵」。