Looks good! Left some suggestions! Are you going to complete the schedule?
I just noticed that you have a special section for testing, from my experience I can suggest to add unit tests while you develop the feature, as adding tests weeks or months later to a big, grown codebase is not a lot of fun and also very hard (maybe even not possible because the code was written untestable weeks ago). At least that are my experiences with testing. On Mon, Mar 23, 2015 at 5:15 PM, Buddhika Jayawardhana <buddhika...@cse.mrt.ac.lk> wrote: > Dear Folks, > > I have prepared a draft proposal for the project based on what I have read > so far. > > How deep I should explain the technical details of the project? > Is the software process which I have suggested is ok? or should I use any > other process? > > This is the link > <https://docs.google.com/document/d/1Yrj73vXAJjBA0-i_Nt78FUipy5oTtZ42UG2TlXmH4y0/edit?usp=sharing> > for the proposal. Please be kind enough to add your comments on the > proposal. > > Thank You > > > On 22 March 2015 at 10:24, Buddhika Jayawardhana <buddhika...@cse.mrt.ac.lk> > wrote: > >> Dear Jan, Robert other devs, >> >> I have prepared a draft proposal for the project. It can be found on this >> link >> <https://docs.google.com/a/cse.mrt.ac.lk/document/d/1Yrj73vXAJjBA0-i_Nt78FUipy5oTtZ42UG2TlXmH4y0/edit?usp=sharing>. >> It is neither complete nor contain much technical details. It is completely >> based on what you have told me and what I have read so far. Please add your >> comments to improve the proposal and point me out if I have misunderstood >> anything you have told me or about the project. >> >> I think I need a deep understanding on stdio. Please point me some >> direction to learn them. >> >> Thank You. >> >> On 21 March 2015 at 22:16, Buddhika Jayawardhana < >> buddhika...@cse.mrt.ac.lk> wrote: >> >>> Thank You Robert, I already have started writing the proposal. I will >>> share the link of the google doc tomorrow morning. >>> >>> On 21 March 2015 at 21:08, Robert Kowalski <r...@kowalski.gd> wrote: >>> >>>> Hi Buddhika, >>>> >>>> no worries - the preparation for each GSoC project is different for >>>> every student. Some projects need more background knowledge in advance >>>> and have to integrate in other way into the codebase, so don't worry >>>> that other folks are submitting code! >>>> >>>> I would suggest to start writing the proposal as far as you can, we >>>> will also give you feedback. The deadline is for submissions is soon. >>>> >>>> I tried to write up some tips for writing the two sections you are >>>> worried about: >>>> >>>> For the "background" section you can just rely on the informations the >>>> community provides plus the background information you gained from >>>> reading the docs (e.g. the current QueryServer protocol [1], the way >>>> the QueryServer operates today and more general informations, like how >>>> you query CouchDB and how you are writing views) - so no worries! >>>> >>>> Regarding the design/description: Jan already gave some suggestions >>>> regarding the steps that are needed. Are there steps missing in >>>> between? How do you measure the success of the project? How do you >>>> plan to work together with Jan & the community? Also describe how you >>>> going to work: are you planning to work iterative, waterfall, using >>>> techniques like test-driven-development, by building a prototype etc? >>>> >>>> I hope I could provide some hints! >>>> >>>> >>>> [1] http://docs.couchdb.org/en/1.6.1/query-server/protocol.html >>>> >>>> On Sat, Mar 21, 2015 at 6:58 AM, Buddhika Jayawardhana >>>> <buddhika...@cse.mrt.ac.lk> wrote: >>>> > Hi Robert, >>>> > >>>> > I I saw some other applicants are submitting pieces of codes. But I am >>>> > still reading the documents Jan and others have sent me. >>>> > >>>> > >>>> > - I am middle of learnYouSomeErlang book. >>>> > - I have around 8 chapters to read in Couch-DB "The Definitive >>>> Guide". >>>> > - Lots of documentation. >>>> > - Most of the source code. >>>> > >>>> > >>>> > I looked at the template that you have sent me and it requires a >>>> > description about the current situation of the project. And design/ >>>> > description of the work. >>>> > I do not have any confidence to write those two paragraphs. But I can >>>> start >>>> > to write the proposal based on the thinks that Jan have >>>> described(Though I >>>> > don't understand all of them). Shall I start that way? or is there any >>>> > other better way. >>>> > >>>> > Waiting for your advices. >>>> > >>>> > On 21 March 2015 at 08:14, Robert Kowalski <r...@kowalski.gd> wrote: >>>> > >>>> >> Hi Buddhika, >>>> >> >>>> >> the deadline for proposals is getting closer, do you have any >>>> >> questions? Is there anything we can help you with? >>>> >> >>>> >> Jan, the ML and I are happy to help! >>>> >> >>>> >> Best, >>>> >> Robert >>>> >> >>>> >> On Thu, Mar 19, 2015 at 1:57 PM, Buddhika Jayawardhana >>>> >> <buddhika...@cse.mrt.ac.lk> wrote: >>>> >> > Thanks Alexander. I'll try this out. >>>> >> > >>>> >> > On 19 March 2015 at 16:59, Alexander Shorin <kxe...@gmail.com> >>>> wrote: >>>> >> > >>>> >> >> Hi Buddhika, >>>> >> >> >>>> >> >> May be some docs could help you: >>>> >> >> http://docs.couchdb.org/en/latest/query-server/protocol.html >>>> >> >> >>>> >> >> The most easiest way to understand it is to play with it. >>>> >> >> Try to enable debug logs for CouchDB (better here stay with 1.x >>>> >> >> series), run view and other functions and see what the >>>> communication >>>> >> >> happens between CouchDB and query server. >>>> >> >> Try to run query server from CLI and send it some commands to it >>>> and >>>> >> >> notice the responces. >>>> >> >> After that, reading the code would be much more simpler since >>>> you'll >>>> >> >> know the idea how it works in general. >>>> >> >> >>>> >> >> -- >>>> >> >> ,,,^..^,,, >>>> >> >> >>>> >> >> >>>> >> >> On Thu, Mar 19, 2015 at 2:24 PM, Buddhika Jayawardhana >>>> >> >> <buddhika...@cse.mrt.ac.lk> wrote: >>>> >> >> > Dear Jan, >>>> >> >> > >>>> >> >> > I tried to read the code you have sent me to understand the >>>> current >>>> >> query >>>> >> >> > server protocol(https://github.com/apache/couchdb >>>> >> >> > /blob/master/test/view_server/query_server_spec.rb). But I could >>>> not >>>> >> >> > understand anything :( . I'm stuck here. Can you point me out a >>>> way to >>>> >> >> > understand the code. (At least a brief explanation). >>>> >> >> > >>>> >> >> > Thanks. >>>> >> >> > >>>> >> >> > On 19 March 2015 at 10:28, Buddhika Jayawardhana < >>>> >> >> buddhika...@cse.mrt.ac.lk> >>>> >> >> > wrote: >>>> >> >> > >>>> >> >> >> Thanks Robert. This would be really helpful. >>>> >> >> >> >>>> >> >> >> On 19 March 2015 at 03:20, Robert Kowalski <r...@kowalski.gd> >>>> wrote: >>>> >> >> >> >>>> >> >> >>> Some of you asked for a template for their proposals, here is >>>> what >>>> >> I've >>>> >> >> >>> found: >>>> >> >> >>> >>>> >> >> >>> http://community.staging.apache.org/gsoc#application-template >>>> >> >> >>> >>>> >> >> >>> Best, >>>> >> >> >>> Robert >>>> >> >> >>> >>>> >> >> >>> On Wed, Mar 18, 2015 at 1:49 PM, Jan Lehnardt <j...@apache.org> >>>> >> wrote: >>>> >> >> >>> > >>>> >> >> >>> >> On 18 Mar 2015, at 13:35, Buddhika Jayawardhana < >>>> >> >> >>> buddhika...@cse.mrt.ac.lk> wrote: >>>> >> >> >>> >> >>>> >> >> >>> >> Dear Jan and Robert, >>>> >> >> >>> >> >>>> >> >> >>> >> It seems I have to do a lot to get to the speed. I have to >>>> gain a >>>> >> >> lot >>>> >> >> >>> of >>>> >> >> >>> >> theorytical knowladge in >>>> >> >> >>> >> >>>> >> >> >>> >> - Erlang. >>>> >> >> >>> >> - Query servers. >>>> >> >> >>> >> - and about the source. >>>> >> >> >>> >> >>>> >> >> >>> >> But I am so exited to learn new things. Currently I am >>>> reading >>>> >> >> >>> >> "learnsomeerlang" and couch db documentation. This is my >>>> first >>>> >> >> attemp >>>> >> >> >>> to >>>> >> >> >>> >> get involve with a large scale open source project and I >>>> need >>>> >> help >>>> >> >> to >>>> >> >> >>> >> clarify the source code. I hope to meet you guys. Hope to >>>> meet >>>> >> you >>>> >> >> >>> guys at >>>> >> >> >>> >> the status meeting. >>>> >> >> >>> > >>>> >> >> >>> > Sounds good, we’re here to help :) (we are not all guys, >>>> though) >>>> >> >> >>> > >>>> >> >> >>> > Best >>>> >> >> >>> > Jan >>>> >> >> >>> > -- >>>> >> >> >>> >> >>>> >> >> >>> >> Regards. >>>> >> >> >>> >> >>>> >> >> >>> >> >>>> >> >> >>> >> On 18 March 2015 at 03:51, Alexander Shorin < >>>> kxe...@gmail.com> >>>> >> >> wrote: >>>> >> >> >>> >> >>>> >> >> >>> >>> On Tue, Mar 17, 2015 at 12:28 AM, Jan Lehnardt < >>>> j...@apache.org> >>>> >> >> >>> wrote: >>>> >> >> >>> >>>> Here is how I would start: >>>> >> >> >>> >>> >>>> >> >> >>> >>> I think you'd forgot a point about protocol design itself. >>>> It >>>> >> >> requires >>>> >> >> >>> >>> in lot of changes. And there is need to think hardly about >>>> is it >>>> >> >> good >>>> >> >> >>> >>> to stay with stdio as a transport if we're going to make >>>> it work >>>> >> >> for >>>> >> >> >>> >>> cluster and much parallel as it is now. Just >>>> reimplementation of >>>> >> >> what >>>> >> >> >>> >>> we have now is interesting, but not very helpful in >>>> mid/long >>>> >> term. >>>> >> >> >>> >>> >>>> >> >> >>> >>> -- >>>> >> >> >>> >>> ,,,^..^,,, >>>> >> >> >>> >>> >>>> >> >> >>> >> >>>> >> >> >>> >> >>>> >> >> >>> >> >>>> >> >> >>> >> -- >>>> >> >> >>> >> *Buddhika Jayawardhana* >>>> >> >> >>> >> Undergraduate | Department of Computer Science & Engineering >>>> >> >> >>> >> University of Moratuwa >>>> >> >> >>> >> *buddhika...@cse.mrt.ac.lk <buddhika...@cse.mrt.ac.lk>* | >>>> >> LinkedIn >>>> >> >> >>> >> <http://lk.linkedin.com/in/buddhikajay/> >>>> >> >> >>> > >>>> >> >> >>> > -- >>>> >> >> >>> > Professional Support for Apache CouchDB: >>>> >> >> >>> > http://www.neighbourhood.ie/couchdb-support/ >>>> >> >> >>> > >>>> >> >> >>> >>>> >> >> >> >>>> >> >> >> >>>> >> >> >> >>>> >> >> >> -- >>>> >> >> >> *Buddhika Jayawardhana* >>>> >> >> >> Undergraduate | Department of Computer Science & Engineering >>>> >> >> >> University of Moratuwa >>>> >> >> >> *buddhika...@cse.mrt.ac.lk <buddhika...@cse.mrt.ac.lk>* | >>>> LinkedIn >>>> >> >> >> <http://lk.linkedin.com/in/buddhikajay/> >>>> >> >> >> >>>> >> >> > >>>> >> >> > >>>> >> >> > >>>> >> >> > -- >>>> >> >> > *Buddhika Jayawardhana* >>>> >> >> > Undergraduate | Department of Computer Science & Engineering >>>> >> >> > University of Moratuwa >>>> >> >> > *buddhika...@cse.mrt.ac.lk <buddhika...@cse.mrt.ac.lk>* | >>>> LinkedIn >>>> >> >> > <http://lk.linkedin.com/in/buddhikajay/> >>>> >> >> >>>> >> > >>>> >> > >>>> >> > >>>> >> > -- >>>> >> > *Buddhika Jayawardhana* >>>> >> > Undergraduate | Department of Computer Science & Engineering >>>> >> > University of Moratuwa >>>> >> > *buddhika...@cse.mrt.ac.lk <buddhika...@cse.mrt.ac.lk>* | LinkedIn >>>> >> > <http://lk.linkedin.com/in/buddhikajay/> >>>> >> >>>> > >>>> > >>>> > >>>> > -- >>>> > *Buddhika Jayawardhana* >>>> > Undergraduate | Department of Computer Science & Engineering >>>> > University of Moratuwa >>>> > *buddhika...@cse.mrt.ac.lk <buddhika...@cse.mrt.ac.lk>* | LinkedIn >>>> > <http://lk.linkedin.com/in/buddhikajay/> >>>> >>> >>> >>> >>> -- >>> *Buddhika Jayawardhana* >>> Undergraduate | Department of Computer Science & Engineering >>> University of Moratuwa >>> *buddhika...@cse.mrt.ac.lk <buddhika...@cse.mrt.ac.lk>* | LinkedIn >>> <http://lk.linkedin.com/in/buddhikajay/> >>> >> >> >> >> -- >> *Buddhika Jayawardhana* >> Undergraduate | Department of Computer Science & Engineering >> University of Moratuwa >> *buddhika...@cse.mrt.ac.lk <buddhika...@cse.mrt.ac.lk>* | LinkedIn >> <http://lk.linkedin.com/in/buddhikajay/> >> > > > > -- > *Buddhika Jayawardhana* > Undergraduate | Department of Computer Science & Engineering > University of Moratuwa > *buddhika...@cse.mrt.ac.lk <buddhika...@cse.mrt.ac.lk>* | LinkedIn > <http://lk.linkedin.com/in/buddhikajay/>
