「Projects using Symfony」に掲載されるまで

  • 3
    いいね
  • 0
    コメント

Symfonyの公式サイトには、Projects using Symfonyというコンテンツがあります。

これは、SymfonyやSymfony Componentを利用しているプロダクトを紹介しているページです。LaravelやComposer、DrupalやMagentoなど、メジャーなライブラリやCMSが並んでますね。

EC-CUBEもE-commerce projectsのページに掲載されています。

このコンテンツに掲載してもらうのは特に難しいことではなく、symfony/symfony-marketingにPull Requestを送れば随時取り込んでもらえます。

以下はEC-CUBEを掲載してもらうために投げたPull Requestです。
https://github.com/symfony/symfony-marketing/pull/366

Pull Requestを投げた時点から少しファイル名などが変わったみたいですが、修正したり作成するのは3ファイルだけ。

  • projects.yml
  • projects/xxx.yml
  • projects/xxx.png

projects.yml

プロダクト名を追記します。他のファイルのファイル名になる文字列です。ハイフンは使えないようです。

projects.yml
- eccube

projects/xxx.png

プロダクトのロゴ画像です。推奨は160x160。

projects/xxx.yml

プロダクトの概要を記載します。こんな感じ。

eccube.yml
name: EC-CUBE
url: http://www.ec-cube.net/
dependencies:
    - https://github.com/EC-CUBE/ec-cube/blob/master/composer.json
description: |
    EC-CUBE is an open source package used to build e-commerce sites.  It is the
    most popular shopping cart system in Japan. Since the release of the
    version in 2006, users can build e-commerce sites for free. Due to its drag
    and drop functionality, users with no programming experience can create
    original online shops with ease.

どのSymfony Componentを利用しているかは、dependenciescomposer.jsonのURLを書いておけば自動的に表示されます。

Pull Requestがマージされてしばらくたつと、Projects using Symfonyにこんな感じで反映されます。マージ後即反映ではなく、少しタイムラグはあるみたいです(1~2日程度?)

マージされるまでのハードルもそれほど高くないようですし、SymfonyやSymfony Componentを使ってプロダクトを開発されているかたは、いちどトライしてみてはいかがでしょうか。