Hello everyone,
I am Shourya, and this is the first draft of my proposal for the project titled:
'Convert scripts to builtins'. I need your feedback and more than that I need help
to improve my project timeline.
Specifically, I'd like your thoughts on the early commencement of the project and
how should I adjust the timeline accordingly. Any guidance the Community can provide
is greatly appreciated :)
Thanks,
Shourya
-x-x-x-x-x-x-x-x-x-x-x-x-x--x-x-x-x-x-x-x-x-x-x-x-x-x-x-x-x-x-x-x-x-x-x-x-x-x-x-x-x
# Convert scripts to builtins
## Contact Information
--------------------
Name : Shourya Shukla
Major : Computer Science and Engineering
E-mail : shouryashukla.oo@xxxxxxxxx
IRC : rasengan_chidori on #git & #git-devel
Mobile no : <<mobile no>>
GitHub : periperidip
Linkedin : shuklashourya
StackOverflow : rasengan__
Address : <<address>>
Time Zone : IST (UTC +0530)
## Background
I am Shourya Shukla, a sophomore in Computer Science and Engineering at the
Indian Institute of Technology Roorkee[1]. I was introduced to programming at
a young age and I have been trying to learn new concepts everyday since. My
interests include modern mobile networks, Internet of Things and system software
development. I have been working on a project which involves providing cellular
network access to users in a disaster-struck are via drones. I love low-level
coding and FLOSS as well. I have been an active part of the Git community since
January of this year, contributing to Git.
## Work Envinronment
I am fluent in C/C++, Java and Shell script, and have an understanding of Python
as well. I use Git as my VCS and Visual Studio Code with integrated GDB as my
primary code editor and Ubuntu 19.10 as my primary Operating System unless the
work specifically needs Windows.
## Contributions to Git
Contributing to Git helped me understand a lot about how modern & robust softwares
work as well as how real world development takes place. I plan on contrubuting even
more to Git and make my contributions count. As of now, my contributions at Git are:
---------------
status: merged
git/git:
[Microproject][2]: Modernise tests and use helper functions in test script.
## The Project: 'Convert scripts to builtins'
#### Overview
There has been an ongoing work in the conversion of various Git commands
such as `add`, `commit`, `blame`, etc. from their shell form into their C form.
`git submodule` is one of the commands left to fully convert into its C form.
Stefan Beller <stefanbeller@xxxxxxxxx> converted a large part of this command
up until 2019. Prathamesh Chavan <pc44800@xxxxxxxxx> also aided in the conversion
of the command during his GSoC project in the year 2017. In its current state, four
subcommands are due for conversion, namely: 'add`, `set-branch`, `set-url` and `summary`.
Also, the Command Line parsing Interface needs improvements, such as better error messages
and support for more subcommands.
#### Project Timeline
I have been studying the code of `submodule.c`, `submodule--helper.c` and `git-submodule.sh`
since the submission of my microproject. After studying the codes, I tried to devise an effective
conversion strategy for `submodule`. I noticed that `submodule.c` contains various helper functions
for `submodule--helper.c` whereas the latter houses the main "converted" command as of now.
Therefore, the timeline looks like:
- Community Bonding Period (April 27 - May 18)
--> Get familiar with the community
--> Improve the project workflow
- Phase 1 (May 19 - June 6)
--> Convert `summary` subcommand
--> Improve CLI parsing
- Phase 2 (June 7- August 8)
--> Convert `add` subcommand
--> Convert `set-url` subcommand
--> Convert `set-branch` subcommand
- Final Phase (August 9 - August 17)
--> Documentation
--> Final touch-ups to code
If there is some extra time left, I will try to implement some BONUS features.
**BONUS features:** Consist of command touch ups and improcing some bugs such as code
sections with 'NEEDSWORK' tags.
## Relevant Work
I have divided the project into 3 subprojects(SP).
1. **SP 1:** Convert `summary`
2. **SP 2:** Convert `add` and improve CLI(Command Line Interface) parsing
3. **SP 3:** Convert `set-url` and `set-branch`
After discussions with Christian Couder, I plan to start SP1 before GSoC itself. Currently,
I am studying the code in detail and constructing a scaffolding for this implementation.
I aim to complete the leftover bits of SP1 during Phase 1 and SP2 & SP3 during Phase 2 of
GSoC.
As Derrick Stolee advised[3], the conversion may not be possible in one whole summer, hence,
I think an early start might be needed to finish things in time if possible.
## Availability
The official GSoC period starts from April 27 and ends on August 17. My vacations start
from May 10 and will be over by July 13. I can easily devote 45-50 hours per week until
the commencement of my Semester. Other than this project, I have no commitments planned
for my vacations. I shall keep the community posted in case of any change in plans.
## Post GSoC
Even after the completion of Google Summer of Code, I plan on continuing my contributions
to Git, on the technical front(in terms of code and documentation contributions) as well
as on the social front(solving people's doubts/problems on the List as well as on StackOverflow).
I vision to convert the remaining of the commands as pointed out by Dscho[3] as well as improve
the test files.
I aim to develop mentorship skills as well as the ability to guide others and try to give back to
the community by mentoring and guiding others as well(by reviewing their code, helping them out, etc.)
------------------------------------------------------------------------------------------------
[1]: https://www.iitr.ac.in/
[2]: https://lore.kernel.org/git/20200116203622.4694-1-shouryashukla.oo@xxxxxxxxx/
[3]: https://lore.kernel.org/git/nycvar.QRO.7.76.6.2001301154170.46@xxxxxxxxxxxxxxxxx/T/#m232941f6cdcf92b97b3531f6fc582935c06734cf
[4]: https://lore.kernel.org/git/nycvar.QRO.7.76.6.2001301154170.46@xxxxxxxxxxxxxxxxx/T/#m637c5c97d42dc68aab85420b5ffcaeb34c270ad3
