Contributing to the Documentation

Before Your First Contribution

Before contributing, you need to:

  • Sign up for a free GitHub account, which is the service where the Symfony documentation is hosted.
    無料の GitHub アカウントにサインアップしてください。これは、Symfony のドキュメントがホストされているサービスです。
  • Be familiar with the reStructuredText markup language, which is used to write Symfony docs. Read this article for a quick overview.
    Symfony のドキュメントを書くために使用される reStructuredText マークアップ言語に慣れてください。簡単な概要については、この記事をお読みください。

Fast Online Contributions

If you're making a relatively small change - like fixing a typo or rewording something - the easiest way to contribute is directly on GitHub! You can do this while you're reading the Symfony documentation.

タイプミスの修正や何かの言い直しなど、比較的小さな変更を加える場合、貢献する最も簡単な方法は GitHub に直接投稿することです!これは、Symfony のドキュメントを読みながら行うことができます。

Step 1. Click on the edit this page button on the upper right corner and you'll be redirected to GitHub:

ステップ 1. 右上隅にある [このページを編集] ボタンをクリックすると、GitHub にリダイレクトされます。

Step 2. Edit the contents, describe your changes and click on the Propose file change button.

ステップ 2. 内容を編集し、変更内容を説明して、[Propose file change] ボタンをクリックします。

Step 3. GitHub will now create a branch and a commit for your changes (forking the repository first if this is your first contribution) and it will also display a preview of your changes:

ステップ 3. GitHub は、変更のブランチとコミットを作成し (これが最初のコントリビューションの場合は、最初にリポジトリをフォークします)、変更のプレビューも表示します。

If everything is correct, click on the Create pull request button.

すべてが正しければ、[プル リクエストの作成] ボタンをクリックします。

Step 4. GitHub will display a new page where you can do some last-minute changes to your pull request before creating it. For simple contributions, you can safely ignore these options and just click on the Create pull request button again.

ステップ 4. GitHub に新しいページが表示されます。ここで、プル リクエストを作成する前に最後の変更を行うことができます。単純な投稿の場合は、これらのオプションを安全に無視して、[プル リクエストの作成] ボタンをもう一度クリックするだけでかまいません。

Congratulations! You just created a pull request to the official Symfony documentation! The community will now review your pull request and (possibly) suggest tweaks.

おめでとう!公式の Symfony ドキュメントへのプル リクエストを作成しました!コミュニティはプル リクエストを確認し、(場合によっては) 微調整を提案します。

If your contribution is large or if you prefer to work on your own computer, keep reading this guide to learn an alternative way to send pull requests to the Symfony Documentation.

あなたの貢献が大きい場合、または自分のコンピューターで作業したい場合は、このガイドを読み続けて、プルリクエストを Symfony ドキュメントに送信する別の方法を学んでください。

Your First Documentation Contribution

In this section, you'll learn how to contribute to the Symfony documentation for the first time. The next section will explain the shorter process you'll follow in the future for every contribution after your first one.

このセクションでは、初めて Symfony のドキュメントに貢献する方法を学びます。次のセクションでは、最初の投稿以降のすべての投稿について、将来従う短いプロセスについて説明します。

Let's imagine that you want to improve the Setup guide. In order to make your changes, follow these steps:

セットアップ ガイドを改善したいとします。変更を行うには、次の手順に従います。

Step 1. Go to the official Symfony documentation repository located at and click on the Fork button to fork the repository to your personal account. This is only needed the first time you contribute to Symfony.

ステップ 1. にある公式の Symfony ドキュメント リポジトリに移動し、[フォーク] ボタンをクリックしてリポジトリを個人アカウントにフォークします。これは、Symfony に初めて貢献するときにのみ必要です。

Step 2. Clone the forked repository to your local machine (this example uses the projects/symfony-docs/ directory to store the documentation; change this value accordingly):

ステップ 2. フォークされたリポジトリをローカル マシンにクローンします (この例では、projects/symfony-docs/ ディレクトリを使用してドキュメントを保存します。それに応じてこの値を変更します):
$ cd projects/
$ git clone

Step 3. Add the original Symfony docs repository as a "Git remote" executing this command:

ステップ 3. 次のコマンドを実行して、元の Symfony docs リポジトリを「Git リモート」として追加します。
$ cd symfony-docs/
$ git remote add upstream

If things went right, you'll see the following when listing the "remotes" of your project:

$ git remote -v
origin (fetch)
origin (push)
upstream (fetch)
upstream (push)

Fetch all the commits of the upstream branches by executing this command:

$ git fetch upstream

The purpose of this step is to allow you work simultaneously on the official Symfony repository and on your own fork. You'll see this in action in a moment.

このステップの目的は、公式の Symfony リポジトリと独自のフォークで同時に作業できるようにすることです。すぐにこれを実際に見ることができます。

Step 4. Create a dedicated new branch for your changes. Use a short and memorable name for the new branch (if you are fixing a reported issue, use fix_XXX as the branch name, where XXX is the number of the issue):

ステップ 4. 変更専用の新しいブランチを作成します。新しいブランチには短く覚えやすい名前を使用します (報告された問題を修正する場合は、ブランチ名として fix_XXX を使用します。XXX は問題の番号です)。
$ git checkout -b improve_install_article upstream/5.4

In this example, the name of the branch is improve_install_article and the upstream/5.4 value tells Git to create this branch based on the 5.4 branch of the upstream remote, which is the original Symfony Docs repository.

この例では、ブランチの名前は Improvement_install_article で、upstream/5.4 の値は、元の Symfony Docs リポジトリであるアップストリーム リモートの 5.4 ブランチに基づいてこのブランチを作成するように Git に指示します。

Fixes should always be based on the oldest maintained branch which contains the error. Nowadays this is the 5.4 branch. If you are instead documenting a new feature, switch to the first Symfony version that included it, e.g. upstream/6.2.

修正は常に、エラーを含む最も古い維持されたブランチに基づく必要があります。現在、これは 5.4 ブランチです。代わりに新しい機能を文書化する場合は、それを含む最初の Symfony バージョン (upstream/6.2 など) に切り替えます。

Step 5. Now make your changes in the documentation. Add, tweak, reword and even remove any content and do your best to comply with the Documentation Standards. Then commit your changes!

ステップ 5. ここで、ドキュメントに変更を加えます。コンテンツを追加、微調整、言い換え、さらには削除し、ドキュメンテーション基準に準拠するために最善を尽くしてください。次に、変更をコミットします。
# if the modified content existed before
$ git add setup.rst
$ git commit setup.rst

Step 6. Push the changes to your forked repository:

ステップ 6.フォークされたリポジトリに変更をプッシュします。
$ git push origin improve_install_article

The origin value is the name of the Git remote that corresponds to your forked repository and improve_install_article is the name of the branch you created previously.

origin の値は、フォークされたリポジトリに対応する Git リモートの名前であり、reprove_install_article は、以前に作成したブランチの名前です。

Step 7. Everything is now ready to initiate a pull request. Go to your forked repository at and click on the Pull Requests link located in the sidebar.

ステップ 7. これで、プル リクエストを開始する準備がすべて整いました。 のフォークされたリポジトリに移動し、サイドバーにあるプル リクエストのリンクをクリックします。

Then, click on the big New pull request button. As GitHub cannot guess the exact changes that you want to propose, select the appropriate branches where changes should be applied:

次に、大きな New pull request ボタンをクリックします。 GitHub は提案したい正確な変更を推測できないため、変更を適用する適切なブランチを選択します。

In this example, the base fork should be symfony/symfony-docs and the base branch should be the 5.4, which is the branch that you selected to base your changes on. The head fork should be your forked copy of symfony-docs and the compare branch should be improve_install_article, which is the name of the branch you created and where you made your changes.

この例では、ベース フォークは symfony/symfony-docs であり、ベース ブランチは 5.4 である必要があります。これは、変更のベースとして選択したブランチです。 head フォークは symfony-docs のフォークされたコピーである必要があり、compare ブランチは、作成したブランチの名前であり、変更を加えた場所である Improvement_install_article である必要があります。

Step 8. The last step is to prepare the description of the pull request. A short phrase or paragraph describing the proposed changes is enough to ensure that your contribution can be reviewed.

ステップ 8. 最後のステップは、プル リクエストの説明を準備することです。提案された変更を説明する短いフレーズまたは段落は、あなたの貢献が確認できることを確認するのに十分です。

Step 9. Now that you've successfully submitted your first contribution to the Symfony documentation, go and celebrate! The documentation managers will carefully review your work in short time and they will let you know about any required change.

ステップ 9. Symfony のドキュメントへの最初の投稿が成功したので、行って祝ってください!ドキュメント マネージャーは短時間で慎重に作業をレビューし、必要な変更について通知します。

In case you are asked to add or modify something, don't create a new pull request. Instead, make sure that you are on the correct branch, make your changes and push the new changes:

$ cd projects/symfony-docs/
$ git checkout improve_install_article

# ... do your changes

$ git push

Step 10. After your pull request is eventually accepted and merged in the Symfony documentation, you will be included in the Symfony Documentation Contributors list. Moreover, if you happen to have a SymfonyConnect profile, you will get a cool Symfony Documentation Badge.

ステップ 10. プル リクエストが最終的に受け入れられ、Symfony ドキュメントにマージされると、Symfony ドキュメント コントリビューター リストに追加されます。さらに、SymfonyConnect プロファイルをお持ちの場合は、クールな Symfony ドキュメント バッジを取得できます。

Your Next Documentation Contributions

Check you out! You've made your first contribution to the Symfony documentation! Somebody throw a party! Your first contribution took a little extra time because you had to learn a few standards and set up your computer. But from now on, your contributions will be much easier to complete.

あなたをチェックアウトします!あなたは Symfony ドキュメントへの最初の貢献をしました!誰かがパーティーを開いてください!いくつかの標準について学習し、コンピューターをセットアップする必要があったため、最初の投稿には少し余分な時間がかかりました。しかし、これからは、あなたの貢献ははるかに簡単に完了できるようになります。

Here is a checklist of steps that will guide you through your next contribution to the Symfony docs:

次の Symfony ドキュメントへの貢献をガイドする手順のチェックリストを次に示します。
# create a new branch based on the oldest maintained version
$ cd projects/symfony-docs/
$ git fetch upstream
$ git checkout -b my_changes upstream/5.4

# ... do your changes

# (optional) add your changes if this is a new content
$ git add xxx.rst

# commit your changes and push them to your fork
$ git commit xxx.rst
$ git push origin my_changes

# ... go to GitHub and create the Pull Request

# (optional) make the changes requested by reviewers and commit them
$ git commit xxx.rst
$ git push

After completing your next contributions, also watch your ranking improve on the list of Symfony Documentation Contributors. You guessed right: after all this hard work, it's time to celebrate again!

次の貢献を完了したら、Symfony ドキュメント貢献者のリストでランキングが向上するのを見てください。お察しのとおり、この大変な作業が終わったら、また祝う時が来ました!

Review your changes

Symfony repository checks every Pull Request automatically to look for common errors, inappropriate words, syntax issues in code blocks, etc.

symfony リポジトリは、すべてのプル リクエストを自動的にチェックして、一般的なエラー、不適切な単語、コード ブロック内の構文の問題などを探します。

Optionally you can also build the docs in your local machine to debug issues or to read the documentation offline. To do so, follow the instructions included in the README file of symfony-docs repository.

必要に応じて、ローカル マシンでドキュメントをビルドして、問題をデバッグしたり、ドキュメントをオフラインで読んだりすることもできます。これを行うには、symfony-docs リポジトリの README ファイルに含まれる指示に従います。

Frequently Asked Questions

Why Do My Changes Take So Long to Be Reviewed and/or Merged?

Please be patient. It can take up to several days before your pull request can be fully reviewed. After merging the changes, it could take again several hours before your changes appear on the Symfony website.

しばらくお待ちください。プル リクエストが完全にレビューされるまで、数日かかる場合があります。変更をマージした後、変更が Symfony Web サイトに表示されるまでに数時間かかる場合があります。

Why Should I Use the Oldest Maintained Branch Instead of the Latest Branch?

Consistent with Symfony's source code, the documentation repository is split into multiple branches, corresponding to the different versions of Symfony itself. The latest (e.g. 5.x) branch holds the documentation for the development branch of the code.

Symfony のソース コードと一致するドキュメント リポジトリは、Symfony 自体のさまざまなバージョンに対応する複数のブランチに分割されています。最新 (5.x など) ブランチには、コードの開発ブランチのドキュメントが含まれています。

Unless you're documenting a feature that was introduced after Symfony 5.4, your changes should always be based on the 5.4 branch. Documentation managers will use the necessary Git-magic to also apply your changes to all the active branches of the documentation.

Symfony 5.4 の後に導入された機能を文書化している場合を除き、変更は常に 5.4 ブランチに基づいている必要があります。ドキュメント マネージャーは、必要な Git マジックを使用して、ドキュメントのすべてのアクティブなブランチに変更を適用します。

What If I Want to Submit my Work without Fully Finishing It?

You can do it. But please use one of these two prefixes to let reviewers know about the state of your work:

あなたはそれを行うことができます。ただし、次の 2 つのプレフィックスのいずれかを使用して、レビュー担当者に作業の状態を知らせてください。
  • [WIP] (Work in Progress) is used when you are not yet finished with your pull request, but you would like it to be reviewed. The pull request won't be merged until you say it is ready.
    [WIP] (進行中の作業) は、プル リクエストがまだ完了していないが、レビューを希望する場合に使用されます。プル リクエストは、準備ができていると言うまでマージされません。
  • [WCM] (Waiting Code Merge) is used when you're documenting a new feature or change that hasn't been accepted yet into the core code. The pull request will not be merged until it is merged in the core code (or closed if the change is rejected).
    [WCM] (Waiting Code Merge) は、コア コードにまだ受け入れられていない新しい機能または変更を文書化するときに使用されます。プル リクエストは、コア コードにマージされるまで (または変更が拒否された場合は閉じられるまで) マージされません。

Would You Accept a Huge Pull Request with Lots of Changes?

First, make sure that the changes are somewhat related. Otherwise, please create separate pull requests. Anyway, before submitting a huge change, it's probably a good idea to open an issue in the Symfony Documentation repository to ask the managers if they agree with your proposed changes. Otherwise, they could refuse your proposal after you put all that hard work into making the changes. We definitely don't want you to waste your time!

まず、変更がある程度関連していることを確認します。それ以外の場合は、個別のプル リクエストを作成してください。いずれにせよ、大きな変更を提出する前に、Symfony ドキュメンテーション リポジトリでイシューを開いて、提案された変更に同意するかマネージャーに尋ねるのはおそらく良い考えです。そうしないと、変更を行うために多大な労力を費やした後で、彼らがあなたの提案を拒否する可能性があります。時間を無駄にしたくありません。