From: "Michael Haggerty" <mhagger@xxxxxxxxxxxx> Cc: "Dmitry Dolzhenko" <dmitrys.dolzhenko@xxxxxxxxx>; "Sun He" <sunheehnus@xxxxxxxxx>; "Brian Gesiak" <modocache@xxxxxxxxx>; "Tanay Abhra" <tanayabh@xxxxxxxxx>; "Kyriakos Georgiou" <kyriakos.a.georgiou@xxxxxxxxx>; "Siddharth Goel" <siddharth98391@xxxxxxxxx>; "Guanglin Xu" <mzguanglin@xxxxxxxxx>; "Karthik Nayak" <karthik.188@xxxxxxxxx>; "Alberto Corona" <albcoron@xxxxxxxxx>; "Jacopo Notarstefano" <jacopo.notarstefano@xxxxxxxxx>
Hi, Based on my experience so far as a first-time Google Summer of Code mentor, I just wrote a blog article containing some hopefully useful advice for students applying to the program. Please note that this is my personal opinion only and doesn't necessarily reflect the views of the Git/libgit2 projects as a whole. My secret tip for GSoC success http://softwareswirl.blogspot.com/2014/03/my-secret-tip-for-gsoc-success.html Michael -- Michael Haggerty mhagger@xxxxxxxxxxxx http://softwareswirl.blogspot.com/ --
In particular I liked : " If the documentation is unclear, it is OK to ask for a clarification, but then _fix the documentation_ so that your mentor never has to answer the same question again." So the rhetorical question(s) for students would be :- - was the Git documentation useful - did you see the README?, did it lead, easily, to the useful places [1]? How could the wording/layout be improved for the first time reader? - which points of clarification were most useful and are they in the documentation? Where should they be included? - which points needed repeating often, and why? Where was the disconnect? - what would a patch look like... Philip Oakley [1] README; INSTALL; Documentation/SubmittingPatches; Documentation/CodingGuidelines; -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html