Spark project について

Spark project は、Flash/ActionScript開発のためのオープンソースコミュニティです。 「皆でソースコードやノウハウを共有して、幸せになろうよ」という思いの下で運営されています。

誰でも気軽にソースコードやノウハウを共有できるよう、Subversion, Wiki, Trac といったツールを無償で提供しており、自由に使用することが出来ます。

まずは、「はじめての方へ」をご覧下さい。

オキテ

  • コミットしたら皆兄弟 (仲良くしよう)
  • コミットされたコードは皆のコード (他の人の修正大歓迎)
  • どんどん公開、どんどん共有、どんどん追加

はじめての方へ

Spark project を初めて訪れた方へのご案内です。

ソースコードを使う

Spark project 内で公開されているソースコードは、そのコードのライセンスに従う限り、誰でも自由に使用することが出来ます。 (ライセンスについては、各プロジェクトページ又はそのコード自体に記載されているものを参照して下さい)

ソースコードを使うには、まずそのプロジェクトのページを見て下さい。 ZIP などが用意されていたり、使い方が指示されていたりしたら、それに従って使って下さい。

プロジェクトページが無い場合や、特に指示が無い場合は、Subversion リポジトリから直接ソースコードをチェックアウトすることで入手して下さい。

なお、zyass_tak さんが分かりやすい「Spark project のソースをとりあえず使ってみる方法」をまとめてくださいましたので、そちらもあわせてご覧下さい。

情報を共有する

Wiki は誰でも自由に編集することが出来ます。情報やノウハウの共有に役立てて下さい。

情報交換・雑談・議論などに使えるフォーラムも用意されています。

フィードバックを送る

ソースコードにバグを発見した場合や、要望がある場合、チケットを使ってフィードバックを送ることが出来ます。

コミッタになる

コミッタになると、更に多くのことができるようになります。


もっと Spark

Spark project が提供するツールやサービスについて詳しく紹介します。

Subversion

Spark project では、Subversion と呼ばれるバージョン管理システムを使ってソースコードを管理・共有しています。

リポジトリからのチェックアウト方法を覚えると、共有されているソースコードをダウンロードすることが出来るようになります。

リポジトリ

Subversion では、ファイルを共有する場所 (アドレス) のことを、便宜的に「リポジトリ」と呼びます。

Spark project のリポジトリは、以下の URL になります。ブラウザでアクセスすると、リポジトリ内のファイルを閲覧することが出来ます。

http://www.libspark.org/svn/

リポジトリブラウザを使うと、更に詳しくリポジトリ内を閲覧することが出来ます。

リポジトリ内のファイルの URL

リポジトリ内にあるファイルの URL は、そのファイルのパスの先頭に、http://www.libspark.org/svn/ を付加したものになります。

例えば、

/as3/HogeProject/trunk

であれば、

http://www.libspark.org/svn/as3/HogeProject/trunk

となります。

チェックアウト

Subversion リポジトリ内にあるファイルをダウンロードすることを、便宜的に「チェックアウト」と呼びます。

チェックアウトは、ダウンロードするファイルやディレクトリのリポジトリ内でのアドレスを指定することによって行います。

Windows の場合は TortoiseSVN、Mac OSX の場合は Versions などのツールを使うと、簡単にチェックアウトが行えます。 詳しくは各ツールの使い方やヘルプ等を参照して下さい。

コミット

Subversion リポジトリ内のファイルの修正や、新しいファイルの追加をアップロードすることを、便宜的に「コミット」と呼びます。

コミットを行うためには、コミッタになる必要があります。

Windows の場合は TortoiseSVN、Mac OSX の場合は Versions などのツールを使うと、簡単にコミットが行えます。 詳しくは各ツールの使い方やヘルプ等を参照して下さい。

Wiki

Spark project のサイトは Wiki がベースになっていて、誰でも自由にページの追加や編集が出来るようになっています。

  • wiki.libspark.org は誰でも自由に編集できます。情報やノウハウの共有に役立てて下さい
  • www.libspark.orgコミッタのみ編集できます。プロジェクトページの作成などに使用して下さい

新規ページの作成

新規ページは以下の手順で作成できます。

  1. 作りたい Wiki ページへのリンクをまず先に作る
  2. リンク先のページに飛ぶと「ページ作成」ボタンがあるので押す
  3. ページの内容を書いて完成

ページの編集

ページは以下の手順で編集できます。

  1. ページ下部にある「ページの編集」ボタンを押す
  2. ページの内容を編集して完成

フォーラム

Spark project では、XOOPSによるフォーラムを用意しています。フォーラム内でユーザー登録すれば、誰でも自由に書き込むことが出来ます。 雑談・情報交換・議論などにご活用下さい。

Trac

Spark project のサイトは Trac と呼ばれるプロジェクト管理ツールをベースに構築されており、Trac が提供する以下の機能を利用できます。

ログイン

コミッタになると、Trac へログイン可能になり、いくつかのことができるようになります。詳しくはコミッタになるとできることをご覧下さい。

Trac へログインするには、ページ上部のログインリンクを選択し、アカウント情報を入力します。

タイムライン

タイムラインは、Subversion リポジトリへのコミット、チケットの登録・変更、Wiki ページの追加・更新などのログを、時系列で見るための機能です。

RSS も配信しているので、登録すれば、RSS リーダーで Spark project を素早くチェックできるようになります。

リポジトリブラウザ

リポジトリブラウザは、ブラウザ上から Subversion リポジトリを見るための機能です。 現在のリポジトリの内容だけでなく、過去のバージョンや、ログを閲覧することも出来ます。

チケット

チケットは、バグや不具合報告、意見や要望といったフィードバックを簡単に管理するための機能です。

チケットの閲覧

チケットを見る」から、登録されたチケットで未解決のものの一覧を見ることが出来ます。

レポート一覧」では、どのチケット一覧を見るか選択することも出来ます。

チケットの登録

チケットを登録」から、誰でも (コミッタでなくても) 簡単に登録することが出来ます。

最低限、以下を記入すれば OK です。

  • お名前: チケットを登録するあなたの名前
  • チケットの分類:
    • 不具合報告であれば「defect」
    • やるべきことであれば「task」
    • 機能要望であれば「enhancement」
    • 議論や意見であれば「discussion」
    • 一致するものが無ければ、近いものか「discussion」を選んで下さい
  • チケットの概要: 今回のタイトルを簡潔に
  • チケットの内容: 今回の内容

例として、HogeLibrary にバグを発見し、それを開発者に知らせるためのチケットを登録するとすると、

  • お名前: yossy
  • チケットの分類: defect
  • チケットの概要: HogeLibrary で xxx がうまく動作しない
  • チケットの説明: aaa を bbb した状態で ccc すると、xxx がうまく動作しません。再現手順 1. nnnnn 2. mmmm 3. ooooo

のようになります。バグ報告の場合、再現手順なども入れると Good です。

チケットの操作

登録後のチケットには、さらにコメントを追加して捕捉や議論をすることができます。

また、コミッタになると、状態を更新して管理することが出来ます。状態には以下のようなものがあります。

  • チケットに着手する: そのチケットに関する作業 (不具合報告であれば修正など) をはじめたよ!と宣言する
  • 解決にする fixed: そのチケットに関する作業が終了したと宣言する
  • 解決にする invalid: そのチケットが無効であることを宣言する (不具合報告が勘違いだった場合など)
  • 解決にする wontfix: そのチケットには手をつける必要がないことを宣言する (不具合ではなく仕様だった場合など)
  • 解決にする duplicate: そのチケットが既に他のチケットで報告済みのものであることを宣言する
  • 解決にする worksforme: そのチケットだけど僕のところでは問題ないよと宣言する (参考)

解決されたチケットは閉じられ (クローズ) 、未解決のチケット一覧には表示されなくなります。なお、解決を差し戻すことも出来ます。

マイルストーン

マイルストーンは、プロジェクトの新バージョンやリリース目標といった計画を管理するための機能です。

マイルストーンの閲覧

ロードマップ」から、登録されているマイルストーンの一覧を見ることが出来ます。

マイルストーンの登録

ロードマップ」の「マイルストーンの登録」ボタンで新しいマイルストーンを登録できます。 登録の際には、マイルストーンの名称と完了期限、説明などを設定します。

マイルストーンを登録するためには、コミッタになる必要があります。

マイルストーンを登録すると、チケットを登録する際のマイルストーン一覧に現れるようになり、選択すると、マイルストーンを見るときに付随するチケットの状況も確認できるようになります。


コミッタになろう

コミッタとは、Subversion リポジトリへのコミットが可能な人のことを言います。 Spark project では、ほかにもいくつかのことができるようになります。

コミッタは随時募集中ですので、お気軽にどうぞ!

コミッタになるには

希望のユーザー名と、パスワードもしくはパスワードの SHA1 ハッシュを、beinteractive.org@gmail.com まで送ってください。

コミッタになるとできること

コミッタでなくてもできること


コミッタの方へ

コミッタの皆さんこんにちは :D

ここでは、コミッタの方向けの情報をお知らせします。一通り目を通して頂けると助かります。

まずはじめに

はじめてコミッタになられた方、ようこそ Spark project へ。

まずはじめに、Trac にログインして、正しくアカウントが登録されているか確認して下さい。 うまくログインできない場合は、スタッフが登録をミスしているか、メールでお送り頂いたアカウント情報が間違っている可能性があります。 お手数ですが、beinteractive.org@gmail.com までお問い合わせください。

ログインできたら、トップページ下部の「コミッターず」に自己紹介の追加をお願いします。 ページの編集の仕方は、Wiki ページの編集をご覧下さい。

Subversion リポジトリへは、レイアウトルールに従いつつ、自由にコミットして頂いて構いません。

そのほか、チケットマイルストーンもご活用くださいませ。

それでは Spark project で素敵な Flash/ActionScript ライフを!

レイアウトルール

Subversion リポジトリはライブラリごとに以下のようなレイアウトでコミットしてください。

http://wwww.libspark.org/言語/ライブラリ名
  • 言語: as2, as3, mxp などの種類
  • ライブラリ名: ライブラリやプロジェクトの名前

要するに、ルートは種類別にして、その下にもう一個自分でディレクトリを掘ってコミットして下さいということです。

ここだけ守ってもらえれば、あとのレイアウトや名前は自由です。言語もどんどん増やしてもらって構いません。

なお、オススメコミット場所も併せてご覧下さい。

オススメコミット場所

ユーティリティ的なもの:

http://wwww.libspark.org/言語/Utils

パッケージは org.libspark.utils にするとなお良いかもしれないです。

スタディ/実験的なもの:

http://wwww.libspark.org/言語/Study/スタディ名

パッケージ名について

(クラスの) パッケージ名に決まりはありません。はお好きなドメインで OK です。

なお、org.libspark ドメインは自由に使用可能ですので、良かったらお使いくださいませ。

HTML ファイルのコミット

Spark project では、コミットするだけで Web から HTML ページが閲覧可能になる仕組みを用意しています。

http://www.libspark.org/svn/trac/htdocs

以下にファイルをコミットすると、

http://www.libspark.org/htdocs

以下の URL でファイルが閲覧可能になります。

例えば

http://www.libspark.org/svn/trac/htdocs/as3/hoge/index.html

をコミットすると、

http://www.libspark.org/htdocs/as3/hoge/index.html

で閲覧できます。

http://www.libspark.org/svn/trac/htdocs/as3/thread/

みたいな感じで ASDoc を置いたりしているので、ご活用下さい。

コミットログによるチケットのクローズ

コミットログ (コミット時のコメント) に

ほげほげを修正 (fixed: #256)

のように、

fixed: #チケット番号

と書くと、コミット同時にそのチケットを解決 & クローズすることが出来ます ()。

プロジェクトページの作成とリンク

新しいライブラリやプロジェクトをコミットした際は、ぜひ新しい Wiki ページを追加して説明を書いてください (かんたんでも構いません)。

追加したプロジェクトページには、トップページ編集してリンクを張って下さい。その際、そのライブラリやプロジェクトにあったジャンルのところに追加して下さい。

いいジャンルが無い場合は、以下の手順でトップページ編集して追加して下さい。

まず、

=== グラフィック/カラー (AS3) === #graphics-and-color-as3

などを参考に、新しいジャンルの見出しを作ります。このとき、<div id="spark-projects"> の中になるように注意して下さい。

=== 新ジャンル (AS3) === #new-genre-as3

「#」以降は id 名になるので忘れずにつけてください。続いて、その下に自分のライブラリを追加します。

=== 新ジャンル (AS3) === #new-genre-as3

 * [wiki:NewLibrary 新ライブラリ]
  * 新ライブラリです

最後に、各ジャンルへのリンクに今作ったジャンルへのリンクを追加します。

 * [#flash-extension Flash拡張]
 * [#editor-plugin エディタ用]
 * [#new-genre-as3 新ジャンル] <-- 追加

英語ページについて

英語の Wiki ページを作成する場合、ページ名に /en を付加した URL に作成して下さい。

例えば

http://www.libspark.org/wiki/WikiStart

であれば

http://www.libspark.org/wiki/WikiStart/en

になります。


そのほか

そのほかのご案内です。

勉強会

Spark project では、Spark project を中心として Flash や ActionScript? に関するトピックについて勉強する「Spark project 勉強会」を月一回のペースで開催中です。

詳しくは以下のページをご覧下さい。

公式ブログ

Spark project 公式ブログでは、勉強会やイベントの告知をはじめ Spark project の最新情報をお伝えしています。ぜひチェックしてみてください。

Twitter アカウント

Spark project の Twitter アカウントをフォローすると、リアルタイムにコミットログをチェックできるほか、リプライを飛ばすことでフォロワー全員に発言を配信することが出来ます。 ぜひフォローしてみて下さい。

ブログパーツ

このブログパーツを使うと、Spark project のリポジトリ内にコミットされているファイルを簡単にブログに貼付けることが出来ます。サンプルはこちら

以下のコードをコピペしてお使いください。

<script type="text/javascript" src="http://www.libspark.org/thumb/js/..."></script>

このとき、「...」の部分を、表示したいファイルのリポジトリのパスに置き換えてください。例えば、/as3/Thread/src/org/libspark/thread/Thread.as を表示したいときは、

<script type="text/javascript" src="http://www.libspark.org/thumb/js/as3/Thread/src/org/libspark/thread/Thread.as"></script>

とします。

また、GET 引数で以下のオプションが指定できます。

  • w (幅): 表示領域の幅を指定します。値は、HTMLのwidthに指定出来るものがそのまま使用出来ます。省略するとブラウザによって決められます。
  • h (高さ): 表示領域の高さを指定します。値は、HTMLのheightに指定出来るものがそのまま使用出来ます。省略するとブラウザによって決められます。
  • r (リビジョン): 表示するリビジョンを指定します。値は、リビジョン番号で指定します。省略すると、最新のリビジョンになります。
  • l (行指定): 表示する行の範囲を指定します。値は、次のものが指定出来ます。
    • 「n:m」 n行目からm行目まで
    • 「n:」 n行目から最後まで
    • 「:n」 最初からn行目まで
    • 「n」 n行目のみ

例えば、リビジョン151のThread.asの10行目〜20行目を、幅100%、高さ300pxで表示するには次のようにします。

<script type="text/javascript" src="http://www.libspark.org/thumb/js/as3/Thread/src/org/libspark/thread/Thread.as?w=100%&h=300px&r=151&l=10:20"></script>

ロゴデータ

Spark project のロゴデータを Fireworks PNG 形式で用意しています。自由にお使いください。

Spark project では寄付を募集しています。詳しくは以下のページをご覧下さい。

運営スタッフ

Spark project は以下のスタッフによって運営されています。

  • Yoshihiro Shindo a.k.a yossy:beinteractive (BeInteractive!)
    • 代表/運営/リードコミッタ/システム/サーバー
  • fujista (fujista.jp)
    • コミッタ/システム/サーバー
  • minaco (minaco.net)
    • 運営補佐/コミッタ
  • soundkitchen (Humming Via Kitchen)
    • コミッタ/システム/サーバー

お問い合わせ

お問い合わせは beinteractive.org@gmail.com までどうぞ。