git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [GSoC][Draft Proposal v2] Finish converting git submodule to builtin

From
Christian Couder <christian.couder@gmail.com>
Date
Apr 12, 2021, 13:29 UTC
Message-ID
<CAP8UFD16Y7+S0057fYG-K9o85kKVLQBmUZMTB9CVScK8TvM62g@mail.gmail.com>
In-Reply-To
<5E858DC0-E642-4E0D-BDCD-40F62198DE11@gmail.com>
On Mon, Apr 12, 2021 at 7:56 AM Atharva Raykar <raykar.ath@gmail.com> wrote:
> On 12-Apr-2021, at 01:02, Kaartic Sivaraam <kaartic.sivaraam@gmail.com> wrote:
> > On 11/04/21 3:10 pm, Atharva Raykar wrote:
Show 35 quoted lines
> >> The example I gave for how to handle the presence of the remote flag
> >> and the function that performs the module updation method (ie, the `case`
> >> on line 611) was just to illustrate the above workflow, rather than say
> >> that this is how I will exactly do it.
> >> I also would like to know what level of granularity is ideal for the
> >> proposal. For now I have tried to keep it at "whatever I will surely
> >> follow through when I work on the project", which at the moment is the
> >> covered by the four points I mentioned above.
> >> If I go too much into detail about the functions and arguments
> >> of every helper in my example, I will feel compelled to do the same for
> >> the `git submodule add` example. I also will have to reason more carefully
> >> because I do not want to end up in a situation where I do not actually
> >> stick to my proposal all that much, because I realise in my investigation
> >> phase that there is a different, much better way.
> >> Do let me know what is preferred.
> >
> > It makes sense that you don't want to go into too much detail in your
> > proposal. I think Christian wasn't expecting it either. As far as I
> > understand, he was just trying to make your proposal clear to the person
> > who reads it. Just mentioning something like,
> >
> >  This would perform the work being done by the shell script past the
> >  flags being parsed and make the necessary call to `update_clone()',
> >  which returns information about the cloned modules.
> >
> > is not clear as it doesn't say how you're "thinking" the function would
> > return information. Mention this would be helpful for the reader to know
> > what your expectations are and if they need any correction. So, it is
> > better to mention such related information to make your proposal
> > complete. The high-level flow looks good to me.
>
> Alright, I get what you mean. I hope my v3 communicated my intention
> more clearly. Translating my thoughts to text is hard work, and the
> good part of revisiting my proposal and fleshing out the details is
> it is forcing me to understand the problem better :)

Yeah, the idea is that you should try to show in your proposal that you have understood some of the problems well enough. If there are things that are not clear or not very detailed, they are not very useful as they won't show us that you have understood much. It's better to focus on a few things or examples and explain them clearly and with enough detail, than to try to cover a lot of ground in a vague way.

In other words if you can explain well a sensible plan to convert a small part of the code, and give sensible details about that small part, we can have trust that you will manage to do it for the whole project even if some of the details change.

Previous: Atharva RaykarNext: Atharva Raykar
Message 8 of 11 in “[GSoC][Draft Proposal] Finish converting git submodule to builtin”
  1. Atharva RaykarApr 3, 2021
  2. Christian CouderApr 5, 2021
  3. Atharva RaykarApr 8, 2021
  4. Christian CouderApr 10, 2021
  5. Atharva RaykarApr 11, 2021
  6. Kaartic SivaraamApr 11, 2021
  7. Atharva RaykarApr 12, 2021
  8. Christian CouderApr 12, 2021
  9. [GSoC][Draft Proposal v3] Finish converting git submodule to builtinAtharva Raykar, Apr 11, 2021
  10. Atharva RaykarMay 14, 2021
  11. Kaartic SivaraamMay 16, 2021

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.