ユーザー会ドキュメント整備への参加方法

日本Symfonyユーザー会のサイト内のドキュメントは、Symfony本家のドキュメントがそうであるように、オープンソースの思想に基づいて作成・管理されています。 ほぼすべてのドキュメントはGitHub上で管理されているので、ドキュメントのソースを自由に取得することができます。 また、ドキュメントの不備の修正や、追加したいドキュメントを追加することもできます。

以下では、ドキュメントを修正したい場合と、ドキュメントを追加したい場合の2通りの手順を、それぞれ説明します。

GitHubを使ったことがない方、アカウントをまだ作成されていない方は、以下のドキュメントをあらかじめお読みになって、アカウントやGitの使える環境を準備してください。

既存のドキュメントを修正したい場合

既存のドキュメントを修正する場合は、GitHubでドキュメントが含まれるリポジトリをForkし、Forkしたリポジトリでファイルを編集してコミットしたら、Pull Requestを送って下さい。 この時、Pull Requestのメッセージとしてできるだけ変更箇所や変更理由を添えてください。

この手順が分からない方は、次のページを参照してください。

既存のリポジトリにドキュメントを追加したい場合

イベントやブログ記事の紹介、既存のチュートリアルの記事などを追加したい場合は、上のドキュメントの修正と同様に対象リポジトリをforkして、Forkしたリポジトリでドキュメントのファイルを追加してコミットし、Pull Requestを送って下さい。

この手順が分からない方は、次のページを参照してください。

新規にリポジトリをユーザー会のコンテンツとして追加したい場合

あらたなコンテンツを独立したリポジトリとして作成していただくことも歓迎します。 この場合、ユーザー会サイトのどのURLにマッピングするのかは、ユーザー会メンバーの協議により決定させていただきます。 ユーザー会サイトのシステムで、リポジトリを直接取り込むように設定しますので、リポジトリのURLをご連絡ください。

ドキュメントの表記や用語については、日本語表記ガイドラインを参照してください。

不明点などのお問い合わせ

ドキュメントの修正・追加、リポジトリの追加について、不明点やその他のご連絡は、以下へお願いします。