Korrigieren & Einsenden

Korrekturen einreichen

Ihre ersten paar Änderungen am Handbuch werden Sie als Korrektur einreichen müssen, damit der Abschnitts-Besitzer sie überprüfen kann. Dies soll sicherstellen, dass wir ein Qualitäts-Benutzerhandbuch halten und dass Sie nicht versehentlich etwas Wesentliches kaputtmachen, bevor Sie mit dem System vertraut sind.

Um eine Korrektur einzureichen folgen Sie diesem Ablauf:

  1. Führen Sie alle von Ihnen gewünschten Änderungen durch.

  2. Erstellen Sie mit folgendem Befehl eine Korrekturdatei:

    svn diff > filename.diff

    Dies erzeugt eine einfache Textdatei, die angibt, welche Texte in Ihren Arbeitsdateien gegenüber dem zentralen Repository hinzugefügt, gelöscht oder geändert wurden.

    Wenn Sie Dateien erzeugt oder gelöscht haben, müssen Sie vor der Erstellung der Änderungsdatei svn add /path/to/file oder svn rm /path/to/file ausführen. Für eine Liste der betroffenen Dateien führen Sie svn status aus.

  3. Laden Sie die Korrekturdatei hier hoch. Wenn Sie bislang noch keinen Account haben, können Sie einen registrieren.

  4. Nach dem Hochladen der Korrekturdatei müssen Sie mit „Create a new Revision“ eine neue Revision erzeugen, damit Sie einen Titel und eine Beschreibung Ihrer Änderungen hinzufügen können.

  5. Bitte vergewissern Sie sich, dass das Dokumentationsprojekt im Tag-Feld eingetragen ist, um das Team von Ihrer Korrektur zu benachrichtigen. Sie können das Team auch über die Mailing-Liste kontaktieren, oder über Blender Chat.

  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.

Bemerkung

Wenn Ihre Korrektur Änderungen an oder zusätzliche Bilder beinhaltet, hängen Sie sie einfach an, wenn Sie die Revision erstellen.

Überschaubare Korrekturen werden meist sehr schnell akzeptiert. Wenn Sie daran gewöhnt sind, Änderungen zu machen und kein Feedback mehr benötigen, werden wir den Mittelsmann weglassen und Ihnen direkten Zugang zur Handbuchbearbeitung geben.

Siehe auch

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

Direktes Einsenden (Commit)

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.

Nun müssen Sie lediglich folgenden Befehl ausführen:

svn commit -m "This is what I did"

Wenn Sie den Parameter -m "Nachricht" weglassen, werden Sie aufgefordert, die Nachricht in einem Texteditor einzugeben.

Vergessen Sie nicht, immer svn update vor dem Übermitteln aufzurufen.

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

Bemerkung

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

Ihre modifizierten Dateien werden in das zentrale Verzeichnis hochgeladen, sodass Andere damit arbeiten und weiter kollaborieren können. Einsendungen (Commits) können in der sog. Diffusion des Zentralverzeichnisses nachverfolgt werden. Kurz darauf werden Ihre Änderungen im Online-Handbuch sichtbar.

Writing a Good Commit Message

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.