Thank you Ihor. As I understand you, you are requesting the following
approach:

- That one not change existing STARTUP options in org files as a rule, and
discuss any first
- Avoid the passive form, that is, use "change" instead of "changed"
- Each commit should focus on one type of change only
- All changes should be rigorously documented in commit messages, which
includes detailed ChangeLog entries for every change

On Fri, May 2, 2025 at 6:26 PM Ihor Radchenko <yanta...@posteo.net> wrote:

> Gnarled Grip <gnarledg...@gmail.com> writes:
>
> >> A common convention for commit messages is avoiding passive verbs.
> >>
> >
> > Fixed is not actually passive. Do you mean you'd prefer I use present
> tense
> > instead of past? I.e. fix, rather than fixed?
>
> Yup. See https://orgmode.org/worg/org-contribute.html#org4b5d498
>
> >> > -#+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate
> >> > +#+STARTUP:    align fold nodlcheck oddeven lognotestate
> >
> > If you prefer I make no changes to the options that are fine by me.
> > Otherwise, I will document the changes more carefully.
>
> Commit message should rigorously document every change that is being
> made. Preferably, one commit should also only do one thing.
>
> For this specific change, we have the pretty much the same startup
> options in all the org files in WORG. So, if you want to change this, we
> should better discuss the change first and then, if we do decide that
> changing the existing defaults is worth it, change it everywhere.
>
> >> >  Worg was started by [[http://bzg.fr][Bastien]] in the hope that
> other
> >> Org-ers around will
> >> > -bite into this and start sharing tutorials, example of codes, etc.
> >> > +participate and start sharing tutorials, example of codes, etc.
> >>
> >> Hmm. I am wondering what exactly is the grammatical error you are trying
> >> to fix here? Or do you mean that the style is not good?
> >>
> > You are correct, it's stylistic not grammatical. "Bite into this" is an
> > unusual phrase that isn't standard English.
>
> Actually, it is probably grammatical. "bite into" *is* standard
> English. But it has a totally different meaning:
> https://dictionary.cambridge.org/dictionary/english/bite-into
>
> > It seems you would prefer more
> > precise comments where every change is documented according to its
> category?
>
> Yes. Although, in this particular case, it could suffice if you said
> "Fix several grammatical and stylistic errors".  Stylistic change is not
> far from grammatical fixes. (But, since it seems to be grammatical fix -
> incorrect word, no need)
>
> --
> Ihor Radchenko // yantar92,
> Org mode maintainer,
> Learn more about Org mode at <https://orgmode.org/>.
> Support Org development at <https://liberapay.com/org-mode>,
> or support my work at <https://liberapay.com/yantar92>
>

Reply via email to