The document has been split into two, one for contribution guidelines to malhar on Apex site (discussed in an earlier email) and one for operator development best practices and submitted as pull requests
https://github.com/apache/apex-malhar/pull/350 https://github.com/apache/apex-site/pull/44 Thanks On Tue, Jul 5, 2016 at 4:43 PM, Pramod Immaneni <[email protected]> wrote: > Thanks for the feedback. I think details should be in the operator > developer guide. The guidelines document is a condensed document, that > tells someone what they need to be aware of, in a few sentences for each > topic. Once they read something in this document and they want more detail > they should go to the operator developer guide. I can explain that in the > beginning of the document. > > On Tue, Jul 5, 2016 at 3:49 PM, Ashwin Chandra Putta < > [email protected]> wrote: > >> Added a few comments Pramod, otherwise looks good. Dividing the guidelines >> would probably make sense. Contribution process related guidelines can go >> into contribution guidelines and technical implementation related >> guidelines can go into implementation guidelines. Another thing that might >> be helpful is a section describing a simple process for new contributors >> to >> get started without much complexity. >> >> Regards, >> Ashwin. >> >> On Tue, Jul 5, 2016 at 2:06 PM, Pramod Immaneni <[email protected]> >> wrote: >> >> > I can wait. I can also try to break it up into an abridged set of >> > guidelines and add the details into the operator developer guide if >> > they are missing. >> > >> > > On Jul 5, 2016, at 1:38 PM, Thomas Weise <[email protected]> >> wrote: >> > > >> > > I will also have a look at it. >> > > >> > > Wondering though if it shouldn't replace the existing operator >> developer >> > > guide? >> > > >> > > http://apex.apache.org/docs/apex/operator_development/ >> > > >> > > For the contributing guidelines on the web site, maybe it is better to >> > have >> > > a shorter checklist that gives folks the necessary pointers w/o too >> much >> > > detail? >> > > >> > > http://apex.apache.org/contributing.html >> > > >> > > Thomas >> > > >> > > >> > > >> > > On Tue, Jul 5, 2016 at 1:07 PM, Munagala Ramanath < >> [email protected]> >> > > wrote: >> > > >> > >> Pramod, I'll take a look this evening if you can wait that long. >> > >> Ram >> > >>> On Jul 5, 2016 11:24 AM, "Pramod Immaneni" <[email protected]> >> > wrote: >> > >>> >> > >>> I received some feedback. Any other comments before adding these >> > >> guidelines >> > >>> to the project. >> > >>> >> > >>> Thanks >> > >>> >> > >>> On Fri, Jun 17, 2016 at 3:12 PM, Pramod Immaneni < >> > [email protected] >> > >>> >> > >>> wrote: >> > >>> >> > >>>> Hi everyone, >> > >>>> >> > >>>> I wanted to create a set of guidelines that would help folks that >> want >> > >> to >> > >>>> contribute to Malhar. The goal is that by following these >> guidelines >> > >> the >> > >>>> contributions will be assured a certain level of quality as the >> > >> different >> > >>>> aspects to consider, common missteps and mistakes will be taken >> care >> > of >> > >>>> which in turn would also make the review process smoother by >> reducing >> > >> the >> > >>>> number of review iterations before the contribution gets merged. I >> > >> tried >> > >>> to >> > >>>> capture as much information as I thought would help developers >> towards >> > >>> this >> > >>>> goal based on past experience and exposure, in a document. >> > >>>> >> > >>>> Please go through it and provide your feedback, it will be greatly >> > >>>> appreciated. I will go through your comments and incorporate any >> > >>> necessary >> > >>>> changes. After that I hope this document will become a living >> document >> > >> as >> > >>>> part of the contribution guidelines and evolve with the times. >> > >> >> > >> https://drive.google.com/open?id=1WjbaIogVtMDQwbvxTlQxrFqUbK9D75bk98asW9e5OxA >> > >>>> >> > >>>> Thanks >> > >> >> > >> >> >> >> -- >> >> Regards, >> Ashwin. >> > >
