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