Re: Small changes with big diff
| From: | Peter Cowburn | Date: | Fri, 26 Dec 2014 10:40:25 +0000 |
| Subject: | Re: Small changes with big diff | ||
| References: | 1 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969385291@lists.php.net to get a copy of this message | ||
Season’s greetings doc’ers,
I can only repeat what has already been said. Please keep commit diffs as
informative as possible. Part of that involves not mixing
whitespace/formatting changes with actual content changes. Not doing this
makes life more difficult for translators, or anyone else looking over the
diffs, to see exactly what changed.
If you do want to make a “content change” and fix whitespace, formatting,
etc. then you are encouraged to do so; in separate commits, which should
also hopefully have clear commit log messages. For example, translators
don’t really need to look at a commit logged with “reformatted file to wrap
long lines”.
Cheers,
Peter
On 25 December 2014 at 19:04, Alexander Moskalev <irker@irker.net> wrote:
> Hi!
>
> If you find small mistake in English documentation, or want to add only
> few words in sentence, please, do not reformat all next lines. Yes, it make
> documentation look good with same width of the lines. But it terrible for
> translation. We see in diff all lines, and spent a lot of time to check
> what changes only one symbols or few words.
>
> Thank you!
>
> --
> With regards, Alexander Moskalev
> irker@irker.net
> irker@php.net
> a.moskalev@corp.badoo.com
>