はぢめての Vimpr

このドキュメントの目的

このドキュメントでは「Vimpr に参加したいけどどうすればいいのか、さっぱりわかんない」という人や「github って何?」「リポジトリに push するの、ハジメテなの 」という人が、Vimpr に参加するのに必要な手順を箇条書きにしています。

なお、以下の説明は Linux を前提に書かれているので、他の OS を利用されている方は適宜読みかえてください。

とりあえず push できるようになりましょう

とりあえず Vimpr のリポジトリに push できるようになるまでの初歩的な手順を以下に箇条書きにします。Vimperator plugin を書く能力はすでにあるものとします。

また、以下の説明では "vimpr" ディレクトリ以下にデフォルトの名称でローカル・リポジトリを作成するものとします。これらを変更する場合は適宜読みかえてください。

  1. github のアカウントを作成する
    1. github のアカウントを取得しましょう。無料プランで充分です。
    2. SSH 公開鍵をつくって github に登録しましょう。
  2. コミット権限の取得
    1. 組織オーナーにコミット権限を要求します。
  3. ローカル・リポジトリの作成
    1. console を開きます。
    2. "mkdir vimpr" を実行します。
    3. "cd vimpr" を実行します。
    4. "git clone git@github.com:vimpr/vimperator-plugins.git" を実行します。
    5. SSH 公開鍵を作成する時に設定したパスワードを入力します。
    6. "cd vimperator-plugins" を実行します。
    7. "git pull --rebase" を実行します。
  4. 作業する
    1. "git checkout -b topic_branch_name" を実行します。
    2. 作成した topic branch 上で作業をします。
  5. gitpub 上のリポジトリへの push
    1. "git checkout master" を実行します。
    2. "git pull --rebase" を実行します。
    3. "git rebase master topic_branch_name" を実行します。
    4. "git checkout master" を実行します。
    5. "git merge topic_branch_name" を実行します。
    6. "git push" を実行します。--force オプションは絶対に使ってはいけません
    7. SSH 公開鍵を作成する時に設定したパスワードを入力します。
  6. 後始末
    1. "git branch -d topic_branch_name" を実行します。

以上で github への登録から github 上のリポジトリに push できるまでの手順の解説は終りです。

注意事項

参考資料

github
git
to Top Page