该存储库将帮助您练习GitHub流的基础知识以及如何在开源项目上工作。
这是指向Git的链接一般的链接:https://docs.google.com/presentation/d/1vfsg__2-t7xjygkfs9hfpkmaomn1je0v0h7glyiiy1au/edit?usp = sharing
这些步骤假设您已经在本地安装了Git,您已经创建了一个GitHub帐户,并将您的本地SSH键添加到了它。
使用右上角的“叉”按钮叉。
克隆您的叉子仓库。 git clone [email protected]:<your-github-handle>/git-tuto.git
将原始项目添加为遥远的存储库。 git remote add upstream https://github.com/zaccharieramzi/git-tuto.git
创建一个新的分支机构,将您的名字添加到参加教程的人列表中。 git checkout -b <your-name-or-pseudonym>
将您的名字添加到participants.csv文件中。 echo '<your-name-or-pseudonym>,n' >> participants.csv
舞台并进行改变。 git add participants.csv && git commit -m'Added <your-name-or-pseudonym> to the participants file'
将当地的分支推到遥远的存储库。 git push origin <the-name-of-your-branch>
打开新的拉请请求(PR):https://github.com/zaccharieramzi/git-tuto/compare。您在这里有一个示例公关。
用反馈迭代。
PR(挤压和)合并后,请不要忘记更新本地仓库( git checkout master && git pull upstream master )和遥远的存储库( git push origin master )。
一旦您了解了GitHub流程的工作原理,就可以尝试参加连续集成(CI)教程。但是首先,什么是CI? CI是一个可以最好地描述为对代码的连续测试的过程,因为零件已添加到其中。这样可以确保对代码库的新添加不会意外地改变代码的行为。
存在许多工具,但我们将在这里仅使用Travis CI。要设置它,您只需要注册到他们的网站,就将存储库添加到监视存储库列表中,然后在项目中添加Travis配置文件。 Travis配置文件是一个YAML文件,其中包含有关如何正确运行测试的指令列表。
假设您已经采用了GIT教程的第1-4步。
将文件_function.py添加到功能文件夹中。
在此文件中,编写一个可以轻松测试的简单函数。一个示例是我的功能文件。该函数不必与数字有关,但可以与Python提供的所有内置数据结构有关。
为此新功能添加相应的单元测试。相应的单位测试的一个示例是我的。
执行GIT教程的第6-10个步骤,但您需要更适合提交消息的稍有例外。
您可以自由地建议使用此回购问题对演示文稿和本教程进行改进。例如,可能是添加贡献指南的第一个好的贡献。