如何貢獻代碼到Github開源項目

在前端平常開發中,爲了提升開發效率,咱們常常會引用第三方開源庫或框架。例如 jQueryVue.jsiView 等等。前端

而當開源框架現有的功能不能知足咱們的須要時,就須要提 issue ,或提 PR(貢獻代碼)。vue

本文將以 hey-cli-template 爲例,探討如何貢獻代碼到 Github 開源項目中。react

一、需求背景

hey-cli 是一個命令行工具,經過 hey-cli ,咱們能夠一鍵搭建交互式的項目腳手架。webpack

hey-cli-template 是被 hey-cli 引用的項目模板庫,目前包含的模板庫有:git

  1. simple webpack project
  2. simple react project
  3. simple vue project
  4. simple heyui project
  5. simple iviewui project
  6. simple elementui project

如今咱們但願加入一個 simple heyadmin project ,以便一鍵建立 heyadmin 項目。github

在提 issue 被做者回應提 It would be better if you could PR directly. 後(做者很忙啊XD),咱們看看如何PR吧!web

二、開發流程

2.1 Fork 要PR的 Github 項目地址到本身的 Github :

Fork 成功後,以下圖:bash

2.2 Clone 上一步 fork 成功的 Github 項目到本地:

git clone https://github.com/xxx/hey-cli-template.git
複製代碼

2.3 與要 PR 的 Github 項目創建連接:

git remote add upstream https://github.com/heyui/hey-cli-template.git
複製代碼

查看是否創建了連接,此時除了 origin 地址外,還會多兩個 upstream 地址:框架

git remote -v
複製代碼

2.4 建立新分支(分支名可自定):

git checkout -b dev-ak
複製代碼

2.5 修改代碼

2.6 將當前分支推送到本身的遠程倉庫:

git add .
git commit -m "xxxx"
git push origin dev-ak
複製代碼

2.7 上一步完成後,在本身的 Github hey-cli-template 目錄下,會出現下面的提示欄,點擊後編輯內容,便可提交 PR:

2.8 提交成功後,會生成一條 PR。

大功告成,後面就是等待做者check合併了。iview

三、注意事項

每次 PR 以前,記得先與遠程倉庫作代碼同步:

git fetch upstream
git rebase upstream/master
git push origin master
複製代碼

以上。

相關文章
相關標籤/搜索