{"thread":{"id":"53076","subject":"[GSoC proposal RFC] Improvements to git log","startedAt":"2020-03-23T21:59:27Z","lastAt":"2020-03-23T21:59:27Z","messageCount":1,"participants":["Parth Gala"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"393834","messageId":"b80d9b2a-9fff-bd30-5761-b1f26227b484@gmail.com","threadId":"53076","inReplyTo":null,"subject":"[GSoC proposal RFC] Improvements to git log","fromName":"Parth Gala","fromEmail":"parthpgala@gmail.com","sentAt":"2020-03-23T21:59:19Z","receivedAt":"2020-03-23T21:59:27Z","isPatch":false,"sender":{"key":"parthpgala@gmail.com","avatar":null},"body":"Hello everyone, Thanks for taking the time out to read my GSoC proposal. \nI would love to receive feedback on this. One question I have is that \nhow should I contact my mentor(Christian Coulder) in the period from \nApril 4 - April 26 stated below, which will be akin to the community \nbonding period for me, ie do the conversations take place on the mailing \nlist or personal emails or any other medium ? Google docs : \nhttps://docs.google.com/document/d/1H06V1sjE2i74NtXihiDNnApvx0iMemU2RotHt0SeDCI/edit# \n-------------x--------------x----------------x--------------x---------------x---------- \nImprovements to git log\n\n## Contact Information Name Parth Gala Major Electronics and \nCommunications Engineering Email parthpgala@gmail.com Mobile No. \n+91-829-125-7343 Github ParthGala2k Linkedin Parth Gala IRC parth56 \nTimezone IST (UTC +0530)\n\n## Background\nHello, my name is Parth Gala, I am a sophomore majoring in Electronics \nand Communications Engineering at Dwarkadas J. Sanghvi College of \nEngineering.I have been programming since a few years now and have been \ninquisitive to learn more about new things in the field of Computer \nScience. I am proficient in C/C++, Java and Shell script and try to run \nredundant tasks using scripts.\n\n## Work Environment\nI use Vim as my primary code editor and GDB as the debugger. I have been \nusing Linux(Ubuntu 18.04) as my primary operating system since two years \nnow and was introduced to the world of open source about a year ago when \nI started to learn Git and Github and have gained sufficient familiarity \nwith each of them.\n\n## Motivation\nI have been active in the git community since January this year. I was \ninspired to contribute open source since it is a great way to get \nstarted with making enterprise level software which is well documented \nand tested. Google Summer of Code is the best way to get kick started in \nthat direction, and given I use git on a regular basis and would \ncontinue doing so, it would be a great experience contributing to it as \nwell. ## Previous Contributions Contributing to git helped me realize \nhow high quality software is developed by first\nconsidering the design, adding unit tests and more importantly, about \nusing git itself\nbetter to maintain a neat commit history and tracking newer changes.\n\n* Contributions to git\n\n1. GitGitGadget https://github.com/gitgitgadget/git/pull/545\nMailing list \nhttps://lore.kernel.org/git/pull.545.git.1581535151.gitgitgadget@gmail.com/ \nStatus Yet to be merged\n\n2. GitGitGadget     https://github.com/gitgitgadget/git/pull/582 Status \nBeing reviewed by Johannes Schindelin before submitting to mailing list \n<https://github.com/gitgitgadget/git/pull/582>\n\n## Project * Abstract\n`’git log’ is a frequently used command that displays commit history of \nthe branch in various formats in order to make it easier to analyse the \nchanges made to code over a course of time and using various flags that \nhelp you filter out only the commits that you need.\n\n## Current Shortcomings 1. Although there are various options in git \nlog, still a few are missing that many users would like for example “git \nlog --oneline” shows the decorations right after the commit hash but \nbefore the commit message causing the alignment of messages to be \ndisturbed. This can be overcome by setting a custom format string to \nprint the decorations after the message. Having the decorations at the \nend has its own disadvantages, say, you only need to check the status of \na branch rather than its contents, then you would prefer to have the \ndecorations right next to the shortened commit hash. 2. Another \ndesirable feature to have is a date line like ‘==DATE==’ in the log \noutput right over the commits wherever a date changes.\n\n## Goals\n1. Create a --pretty=concise format to deal with the first issue. 2. \nCreate a --log-day option to show date.\n\n## Timeline Tentative\n\n# April 4 - April 26\nDiscuss the compatibility of --log-day option with all other log options \nand finalise its design so as to be easily extended or modified for \nsimilar future enhancements such as --log-month or --log-day[range], \n--log-day[onwards] options and whether the option asks for author date \nor the commiter date upon Junio's advice and do the same for \n--pretty=concise. Also discussion of the stitching of these two \noptions(output for when both are used together) shall be done in order \nto decide how the design should be done. At the same time go through as \nmuch of the relevant code in detail as possible for the said \nenhancements. I will be mostly unoccupied during this period and hope to \ncomplete largely all the ‘community bonding period’ work with my \npotential mentor Christian Coulder during this period itself.\n\n## Community Bonding Period : April 26 - May 16\nI will be having some submissions during the first few days of this \nperiod followed by my end semester exams which will start May 4 and end \nMay 16. Since there are generous holidays between each paper, I intend \nto keep a check on my GSoC project and be in touch with Christian during \nthis period for around 2 hours a day to depending on what needs to be \ndiscussed or finalised before the project starts. I also hope to \nfinetune the project workflow and make timeline changes if necessary \nduring this period.\n\n## Phase 1 : May 18 - June 13\n1. Complete the --pretty=concise format option. 2. Add tests and \ndocumentation for the same.\n\n## Phase 2 : June 14 - July 28\n1. Work on the --log-time option. 2. Add tests and documentation for the \nsame.\n\n## Phase 3 : July 29 - August 10\n1. Implement usage of both the commands simultaneously. 2. Update tests \nfor both the previous phases.\n\n## Final Phase : August 10 - August 17\n1. Polish the patches to apply final touch-ups(if any) 2. Update \ndocumentation. If there is any extra time left, I would like to discuss \nthe viability and use of --log-month\noption with the community and add it to the entire package if many users \non the mailing\nlist would find that option useful to their workflow.\n\nI plan to communicate with my mentors in the form of PRs against my own \nforkof the\nproject and also intend to keep the community updated with my progress \nin the form of\nweekly reports on the mailing list and inform everyone involved in case \nof any changes to the timeline.\n\n## Availability\nI will be done with my mid-sems by April 4 following which I will be \nlargely unoccupied for 3 weeks until April 26 in which period I plan to \ncomplete my obligations for the community bonding period. My end sems \nwill start May 4 upto May 16, so I will be relatively busy for a week \nbefore it, but due to generous holidays between I will be able to work \nupto 2 hours on my GSoC Project. My vacations will start May 17 upto the \nsecond week of July, so during this period I will be easily able to \ndevote 45-50 hours a week. Even after my college resumes, I will be able \nto contribute around 40 hours a week to the project. Apart from this I \nhave no other commitments or plans for the summers barring the odd \nweekend trek ;-)\n\n## Post GSoC\nI would love to learn from such a rich community of developers who have \nbuilt a tool that a majority of the software world uses on a daily \nbasis. Needless to say that only the lure of the new features would also \nbe enough to bring me back to the community again and again but I will \nstill contribute to the community in code and discussions post GSoC, and \nif possible be a co-mentor someday ?\n\n## Final Remarks\nI am a quick learner with a knack of not giving up on problems. I can \nhave a go at it all day long and learn everything necessary to git(get) \nthe job done. Selected or not I will continue to hustle and contribute \nto git and other open source projects that interest me and improve \nmyself and the planet little by little everyday. After all that’s what \nopen source is all about !\n\n-----------------x-------------x------------x-------------x-------------x--------------x-------------x--------- \n\n\n"}]}