0%

向 TheAlgorithms/Python 贡献代码须知

第一次向开源项目提交 pr,还不太熟,于是搜了一下,找到:GitHub 如何向开源项目提交 pr

  • fork 到自己的仓库
  • git clone 到本地
  • 上游建立连接
    • git remote add upstream 开源项目地址
  • 创建开发分支(非必须)
    • git checkout -b dev
  • 修改提交代码
    • git status git
    • add . git commit -m ...
    • git push origin branch
  • 同步代码三部曲
    • git fetch upstream
    • git rebase upstream/master
    • git push origin master
  • 提交pr
    去自己 github 仓库对应 fork 的项目下 new pull request

另外由于每个开源项目都有自己的要求,比如 TheAlgorithms/Python 提交 pr 都会进行各种格式检查,所以先本地 check 一下就可以避免出现格式语法错而得重新 commit 的浪费时间问题,下面是一个维护者提出的步骤:

1
2
3
4
5
black <filename>
isort <filename>
flake8 --ignore=E203,W503 --max-complexity=25 --max-line-length=88 --statistics --count <filename>
mypy --ignore-missing-imports <filename>
pytest --doctest-modules <filename>

Welcome to my other publishing channels