Adding your template to E2D3_ja

Yasuhide Minoda edited this page Sep 25, 2016 · 3 revisions
Clone this wiki locally

初心者の方は,

データ可視化テンプレートを新しく追加する(Github Desktop を用いる方法)

を参照して下さい。

データ可視化テンプレートを新しく追加する

E2D3のデータ可視化テンプレートは、GitHubのe2d3-contribレポジトリがそのままExcel上で表示されるような仕組みになっています。

新しくテンプレートを作成しE2D3ユーザ全員に公開してもよいなと思った場合には、e2d3-contribに対してpull requestを投げてみてください。

下記に大まかな一連の手順を示します。gitやGitHubの使い方はもっと詳しく解説してあるサイトがたくさんあるので、よくわからなかったらそちらを参照してください。

1. e2d3-contribレポジトリをForkする

作業を始めるにあたって、初めにレポジトリをForkして自分専用に分岐させます。GitHubのe2d3-contribのレポジトリで右上のForkボタンを押してください。

もし、プロジェクトに所属していたりしてFork先に複数の選択肢がある場合は、一覧が表示されるので、適切なものを選択します(普通は個人のものを選びます)。

これで自分のレポジトリ一覧にe2d3-contribのレポジトリが表示されるようになります。

2. レポジトリを自分の手元のPCにcloneする

$ git clone git@github.com:chimerast/e2d3-contrib.git
Cloning into 'e2d3-contrib'...
remote: Counting objects: 439, done.
remote: Total 439 (delta 0), reused 0 (delta 0), pack-reused 439
Receiving objects: 100% (439/439), 4.95 MiB | 492.00 KiB/s, done.
Resolving deltas: 100% (215/215), done.
Checking connectivity... done.

次に、Forkした個人のレポジトリから、手元のPCに対してcloneを行います。

3. 作業用ブランチを作成する

$ cd e2d3-contrib

$ git checkout -b simple-pie-chart
Switched to a new branch 'simple-pie-chart'

cloneしたe2d3-contribディレクトリ移動し、新しい作業用ブランチを作成します。ここでは、simple-pie-chartという名前をつけていますが、どのようなテンプレートを追加するのか適切な名前をつけてください。

4. 新しい可視化テンプレートを作成する

$ cp -r barchart-javascript piechart-javascript
$ e2d3

新しい可視化テンプレートを作成してください。既存のテンプレートをコピーするところから始めても良いと思います(上ではbarchart-javascriptからコピーしています)。

その後、e2d3コマンドを使用して、ブラウザで確認しつつテンプレートを編集し、最終的には Excel 2013 もしくは Excel Online で、データの更新やウィンドウサイズの変更をしても問題ないことを確認してください。

5. コミットしてプッシュする

# gitに新しく追加したファイルを通知する
$ git add piechart-javascript

# ローカルのレポジトリにコミットする
$ git ci -m "Add simple pie chart"

# GitHubにプッシュする
$ git push origin simple-pie-chart

作り終わったら、コミットしてGitHubにプッシュしてください。

6. Pull requestを作成する

最後に、E2D3にpull requestを送信します。

プッシュし終わったらブラウザでGitHubの自分のレポジトリを見てみると「Compare & pull request」というボタンがあるので押します。

Pull request作成画面になったら、まず、どこからどこにpull requestを送信するのか確認してください。左側のbase forkがe2d3-contrib:master、右側のhead forkが今回新しく作成したブランチになるようにします(デフォルトのままで良いはずです)。

続いて、下の方にあるテキストボックスにどのようなテンプレートを作成したのか、タイトルとともに記述してください。

終わったら、「Create pull request」のボタンを押します。

Pull requestの送信に成功すると上記のような画面になるので、E2D3のメンバーにマージされるまで待ちます。

場合によっては修正依頼がコメントとして書かれることがあると思いますが、その場合は、修正を行ってコミット&プッシュをしてください。

7. マージ後

メンバーによってマージされると上記のように紫色の「Merged」という表示に切り替わります。

この状態になると、E2D3の本番システムにテンプレートが公開された状態になります。