Popravki in pošiljanje

Oddaja popravkov

Ko boste naredili prvih nekaj sprememb, jih boste morali oddati kot popravke (ang. patches), da jih bo administrator pregledal. To je samo varnostni ukrep, s katerim ohranjamo kakovost priročnika in preprečujemo, da česa resnega ne pokvarite, preden se navadite na sistem.

Popravke oddate tako:

  1. Naredite želene spremembe.

  2. Ustvarite datoteko popravka tako, da zaženete:

    svn diff > filename.diff

    To ustvari preprosto besedilno datoteko, ki pokaže, kaj je bilo dodanega, odstranjenega ali spremenjenega v vaših delovnih datotekami in osrednjim repozitorijem.

    Če ste ustvarili ali izbrisali datoteke, boste morali izvesti ukaz svn add /path/to/file ali svn rm /path/to/file, preden ustvarite datoteko popravka. Seznam datotek, na katere vaše spremembe vplivajo, lahko vidite z ukazom svn status.

  3. Datoteko naložite sem. Če še nimate ustvarjenega računa, se lahko registrirate tukaj.

  4. Ko enkrat oddate datoteko, boste morali ustvariti novo revizijo (“Create a new Revision“), preden dodate naslov in opis svojih sprememb.

  5. Please check if the Documentation project is assigned in the tag’s field in order to notify the team of your patch. You can also contact the team over the mailing list or 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.

Opomba

Če vaš popravek vsebuje spremenjene ali dodane slike, jih preprosto priložite kot priponko, ko ustvarite revizijo.

Enostavni popravki so pogosto zelo hitro sprejeti. Ko se boste enkrat navadili na urejanje dokumentacije in ne boste več potrebovali povratnih informacij, boste dobili neposreden dostop do urejanja priročnika.

Poglej Tudi

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

Neposredno pošiljanje (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.

Zdaj morate samo še izvesti ukaz:

svn commit -m "This is what I did"

Če izpustite -m "sporočilo", boste naprošeni, da sporočilo natipkate v urejevalnik besedila.

Ne pozabite vedno izvršiti ukaza svn update, preden pošljete spremembe.

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

Opomba

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

Vaše spremenjene datoteke so prenesene v centralni repozitorij, da bodo z njimi lahko delali tudi ostali. Pošiljke (commits) so zabeležene v repozitorijih Diffusion. Kmalu zatem bodo vaše spremembe vidne v spletnem priročniku.

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.