[ovirt-devel] Best (and up-to-date) practices for developers?

[Phillip Bailey]

I like that idea. I would prefer having the smaller, more focused files in
a directory. I would probably call it documentation or something similar,
though.

-Phillip Bailey

On Tue, Sep 20, 2016 at 9:14 AM, Roy Golan <rgolan at redhat.com> wrote:

>
>
> On 19 September 2016 at 15:18, Martin Betak <mbetak at redhat.com> wrote:
>
>> Yeah definitely +1.
>>
>> Even after being with the project for some time, I often wonder about
>> things
>> like in what order should fields in class be based on their function (as
>> in
>> logger, static sonstants, @Injected dependencies, actual instance
>> fields...)
>> so such document could answer questions like this (that are not encoded in
>> existing checkstyle rules) or provide general high-level guidance
>> throughout
>> the code base - at least for things that don't change that much. For
>> example
>> I believe that the process to invoke a command (or a query) from the
>> Backend
>> via the VdcActionType, CommandFactory .etc hasn't changed that much,
>> and probably won't change in the foreseeable future :-)
>>
>> Martin B.
>>
>> ----- Original Message -----
>> > From: "Phillip Bailey" <phbailey at redhat.com>
>> > To: "Martin Sivak" <msivak at redhat.com>
>> > Cc: "engine-devel at ovirt.org" <devel at ovirt.org>
>> > Sent: Monday, September 19, 2016 1:54:23 PM
>> > Subject: Re: [ovirt-devel] Best (and up-to-date) practices for
>> developers?
>> >
>> > +1 for the idea if it doesn't already exist. It would ease development
>> for
>> > those already working on the project, but it would also make it easier
>> for
>> > others who would like to contribute to it, but aren't comfortable with
>> > navigating such a large code base.
>> >
>> > -Phillip Bailey
>> >
>> > On Mon, Sep 19, 2016 at 3:56 AM, Martin Sivak < msivak at redhat.com >
>> wrote:
>> >
>> >
>> > Hi,
>> >
>> > I just wanted to find out if we have some documentation for the
>> > developers that would give hint on different aspects of the engine
>> > development in terms of coding.
>> >
>> > Like:
>> > - code style (we have the config in sources)
>> > - what libraries are (not) allowed (guava..ehm..)
>> > - how should CDI be used (see https://gerrit.ovirt.org/#/c/63747/ )
>> > - what files need to be touched to properly support translations
>> > - ...
>> >
>> >
>> > It would be cool to have something brief we can search easily. I know
>> > it can get outdated fast, but if we use it only for the important
>> > stuff and review it for each major release (as the major rules do not
>> > change much) we should be able to keep it usable.
>> >
>> > --
>> > Martin Sivák
>> > SLA / oVirt
>> > _______________________________________________
>> > Devel mailing list
>> > Devel at ovirt.org
>> > http://lists.ovirt.org/mailman/listinfo/devel
>> >
>> >
>> > _______________________________________________
>> > Devel mailing list
>> > Devel at ovirt.org
>> > http://lists.ovirt.org/mailman/listinfo/devel
>> _______________________________________________
>> Devel mailing list
>> Devel at ovirt.org
>> http://lists.ovirt.org/mailman/listinfo/devel
>>
>
>
> I'm all for creating a series of files under our repo for that (and not
> under ovirt-site)
> Something like:
>
> ovirt-engine/
>  - ENGINE_OVERVIEW.adoc
>  - INTERNAL_APIS.adoc
>  - BEST_PRACTICES.adoc
>  - CODING_GUIDES.adoc
>  - REVIEW_GUIDES.adoc
>
> - Another option is to create a long DEVELOPER.adoc (harder to maintain)
> - Or put all those under ovirt-engine/developer/
>
> * I remember there was an initiative for code-of-conduct. Is it alive?
>
>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ovirt.org/pipermail/devel/attachments/20160920/45c1c2c2/attachment-0001.html>