パッチとコミット

パッチの提出

最初の数回マニュアルを変更したら、管理者がレビューするためのパッチとして提出する必要があります。 これは、私たちが高品質のユーザマニュアルを維持し、システムに慣れる前に間違って何かを壊してしまわないようにするためです。

パッチを提出するには、以下の手順に従ってください:

  1. 必要な変更を行います。

  2. 次のコマンドでパッチファイルを作成します:

    svn diff > filename.diff

    これにより、作業ファイルとセントラルリポジトリの間でどのテキストが追加、削除、または変更されたかを示すシンプルなテキストファイルが作成されます。

    ファイルを作成または削除した場合は、diff ファイルを作成する前に svn add /path/to/file または svn rm /path/to/file を実行する必要があります。 影響を受けるファイルのリストを見るには svn status を実行してください。

  3. diff ファイルをここにアップロードしてください 。まだアカウントを持っていない場合は、ここ で登録することができます。

  4. 差分(diff)を送信した後、タイトルと変更の説明を追加する前に、"Create a new Revision" (新しいリビジョンの作成) をするように求められます。

  5. チームがあなたのパッチに気づけるように、タグのフィールドに Documentation プロジェクトが割り当てられていることを確認してください。また、メーリングリストや Blender チャット で 連絡 することもできます。

  6. They will review your patch and let you know about any changes you could make. If there is no issue, your patch will be accepted and then committed by the team of your patch.

注釈

画像の変更または追加がパッチに含まれる場合は、リビジョンを作成するときに添付するだけです。

簡単なパッチは非常に迅速に受け入れられます。 変更に慣れてフィードバックが不要になると、間に人が入るのを省略し、マニュアルを編集するための直接アクセス権が与えられます。

参考

See Release Cycle for documentation on how to make commits to a specific release branch and how to create merge commits.

直接コミットする

Once you are provided with the direct access to edit the manual, you can start committing directly instead of creating a patch file. Doing this will submit the change directly to our central repository.

次のコマンドでコミットできます：

svn commit -m "This is what I did"

-m "コミット名" が抜くていると、テキストエディタでコミット名を入力するように求められます。

コミットする前に必ず svn update を実行してください。

Then you will be asked for your username and password (from developer.blender.org) before the change is committed.

注釈

Make sure to use your username (case sensitive) and not your email.

コミット後にはファイルがセントラルリポジトリにアップされます。コミットが Blender Manual Translations というリポジトリでトラッキングされます。直後に編集がオンラインのマニュアルへ反映されます。

よいコミットメッセージを書く

When making changes to the manual that directly relate to a specific commit (change) in Blender, it is helpful to make the title of the commit the same as the commit made to Blender. It is requested that you include the commit hash of the commit made to the Blender source code.

For example, the commit rBM8473 includes a descriptive indicative of the changes made along with the hash rBa71d2b260170. The hash can be extracted from the URL provided in the Documentation task for a specific upcoming release.

Other more general changes do not have to follow the above policy however, it is still important to make the description clear about what changes you made and why. It can be helpful to prefix the commit title with a prefix word such as Cleanup: or Fix: when you are making general cleanups or fixes respectively.

Writing good commit messages helps administrators keep track of changes made and ensures all new features are properly documented.