ignite-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Vyacheslav Daradur <daradu...@gmail.com>
Subject Re: Abbreviation code-style requirement.
Date Fri, 02 Nov 2018 08:42:16 GMT
I've faced such practice.

Very first my contribution, when I have not been familiar with style
guidelines, Yakov Zhdanov kindly fixed code style issues himself.

I think it depends on a reviewer:
- in one case reviewer can fix issues independently
- in other case ask a contributor to solve them

On Fri, Nov 2, 2018 at 11:31 AM Павлухин Иван <vololo100@gmail.com> wrote:
>
> Andrey, Dmitry,
>
> If we have a practice of formatting a code before merge by committer
> then it is already much better. But do we have such a practice?
>
> As for me personally. I have not felt much discomfort with abbreviations.
> I already used them extensively. Even "cctx", "ccfg" which are not
> mandatory today.
>
> пт, 2 нояб. 2018 г. в 10:58, Dmitriy Pavlov <dpavlov.spb@gmail.com>:
>
> > Hi Ivan,
> >
> > provided that committer has installed ignite-abbrev-plugin it is not a big
> > deal to abbreviate common words before a merge.
> >
> > I had the same impression about abbreviations when I came to the project:
> > "all other development world tends to expose as much meaning as it is
> > humanly possible in code, but Ignite has abbreviations seemed to hide this
> > meaning".  But later I've used to most common abbreviations, like ctx, and
> > I always understand that this implies context.
> >
> > Sincerely,
> > Dmitriy Pavlov
> >
> > пт, 2 нояб. 2018 г. в 10:21, Andrey Kuznetsov <stkuzma@gmail.com>:
> >
> > > Ivan, I agree with you: some our code style rules are really uncommon.
> > >
> > > As for one-time contributions, if somebody decides to make a contribution
> > > to some project, it's ok to adopt that project rules. Moreover, reviewing
> > > committer can silently fix minor code style issues himself upon merge.
> > >
> > > пт, 2 нояб. 2018 г. в 10:08, Павлухин Иван <vololo100@gmail.com>:
> > >
> > > > Andrey, Yakov,
> > > >
> > > > Actually my concert is more about one-time contributions. I imagine
> > > > the following. Someone finds a bug a decides to contribute a fix.
> > > > I think it is quite common scenario in Open Source.
> > > > He creates a PR and awaits a review. I think that a smooth and fast
> > > > review process will encourage for new contributions. But if the review
> > > > process is not such the contributor can simply give up.
> > > >
> > > > P.S. In my mind there are quite uncommon code style rules in Ignite
> > > > project. But it is definitely not for that topic. I imagine some "New
> > > > Contributor Survey".
> > > >
> > > > чт, 1 нояб. 2018 г. в 18:28, Yakov Zhdanov <yzhdanov@apache.org>:
> > > >
> > > > > Ivan I removed "lic" from the list. Thanks for catch!
> > > > >
> > > > > Agree with Andrey. After several code reviews newcomers will get
used
> > > to
> > > > > abbreviations.
> > > > >
> > > > > Andrey, try searching for "fut" and make sure to have "Word" checked.
> > > You
> > > > > will see plenty of usages. "f" is also ok for future in case it does
> > > not
> > > > > bring confusion and does not hurt readability.
> > > > >
> > > > > Let's keep using abbreviations and treat them as mandatory
> > requirement.
> > > > > This is important for keeping our codebase consistent and tidy.
> > > > >
> > > > > --Yakov
> > > > >
> > > >
> > > >
> > > > --
> > > > Best regards,
> > > > Ivan Pavlukhin
> > > >
> > >
> > >
> > > --
> > > Best regards,
> > >   Andrey Kuznetsov.
> > >
> >
>
>
> --
> Best regards,
> Ivan Pavlukhin



-- 
Best Regards, Vyacheslav D.

Mime
View raw message