From: Karthik Nayak <karthik.188@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 2/2] SubmittingPatches: extend the "flow" section
Date: Fri, 10 May 2024 15:09:05 -0400 [thread overview]
Message-ID: <CAOLa=ZRQGFPVD04n_3r5VjHjkxF4bWrW6Po7DyRVfeO9v08TXA@mail.gmail.com> (raw)
In-Reply-To: <xmqqh6f564kp.fsf@gitster.g>
[-- Attachment #1: Type: text/plain, Size: 6020 bytes --]
Junio C Hamano <gitster@pobox.com> writes:
> Karthik Nayak <karthik.188@gmail.com> writes:
>
>>> +=== A not-so ideal patch flow
>>> +
>>> +To help us understand the reason behind various guidelines given later
>>> +in the document, first lets understand how the lifecycle of a typical
>>> +patch series for this project goes.
>>> +
>>> +. You come up with an itch. You code it up. You do not need any
>>> + pre-authorization from the project to do so. Your patches will be
>>
>> Wouldn't it be better to have the following sentences after the next
>> para?
>>
>> So the flow would be
>> - Have an itch. Code it up.
>> - Send patches to list.
>> - Get reviews.
>
> I am not sure what exactly you are suggesting. "The next para"
> meaning? The sentence far below that begins with "In the following
> sections, many techniques and ..."?
>
Let me be more verbose, I was suggesting to change it to:
+. You come up with an itch. You code it up. You do not need any
+ pre-authorization from the project to do so.
+
+. You send the patches to the list and cc people who may need to know
+ about the change. Your goal is *not* necessarily to convince others
+ that what you are building is a good idea. Your goal is to get help
+ in coming up with a solution for the "itch" that is better than what
+ you can build alone.
+
+. Your patches will be reviewed by other contributors on the mailing
+ list, and the reviews will be done to assess the merit of various
+ things, like the general idea behind your patch (including "is it
+ solving a problem worth solving in the first place?"), the reason
+ behind the design of the solution, and the actual implementation.
> Also, "Get reviews" is not a single step that is an end of story, so
> what you wrote is a bit misleading as a short summary.
>
I was trying to be brief, my intention was to capture the whole block
which, I agree wasn't the best shortening.
> The goal of this update is to reduce duplicates by describing a
> typical life-cycle of a patch series from the inception of an idea
> to the decision to include it in the next release here, so the
> proposed "decision making" document can focus on issues at a level
> larger than a topic of a patch series, and a contributor, especially
> a new one who wants to give us their first patch series, can learn
> by only reading these paragraphs how the world works around here
> with their patch series from the beginning to the end. So what
> happens after "Get reviews." is a part of the same "flow". Namely
> these three paragraphs---the original submitter cannot just leave
> with "now it is their problem" after they get reviews. They are now
> integral part of the discussion and we expect to see them see the
> process through.
I see what you're trying to say, my comment was on the fact that it
seemed like there was jumps between the timeline of events and seemed
confusing, with my suggestion we still hold the same points and just
reshuffle the order a little to ensure that the flow of events is a
little easier to understand.
>>> +. While the above iterations improve your patches, the maintainer may
>>> + pick the patches up from the list and queue them to the `seen`
>>> + branch, in order to make it easier for people to play with it
>>> + without having to pick up and apply the patches to their trees
>>> + themselves. Being in `seen` has no other meaning. Specifically, it
>>> + does not mean the patch was "accepted" in any way.
>>> +
>>> +. When the discussion reaches a consensus that the latest iteration of
>>> + the patches are in good enough shape, the maintainer includes the
>>> + topic in the "What's cooking" report that are sent out a few times a
>>> + week to the mailing list, marked as "Will merge to 'next'." This
>>> + decision is primarily made by the maintainer with the help from
>>> + reviewers.
>>> +
>>> +. Once the patches hit 'next', the discussion can still continue to
>>> + further improve them by adding more patches on top, but by the time
>>> + a topic gets merged to 'next', it is expected that everybody agreed
>>> + that the scope and the basic direction of the topic are appropriate,
>>> + so such an incremental updates are expected to be limited to small
>>> + corrections and polishing. After a topic cooks for some time (like
>>> + 7 calendar days) in 'next' without further tweaks on top, it gets
>>> + merged to the 'master' branch and wait to become part of the next
>>> + major release.
>
I wasn't referring to the above three paragraphs and I agree with the
points laid down here, I also happened to have missed reading and
responding to your mail on my series [1], around how to iterate your
patches and check for and resolve conflicts with other ongoing topics.
I think that would be a great value add to these points. I will smoothen
it and send it to the list soon.
>>> +Earlier versions of this document outlined a slightly different patch
>>> +flow in an idealized world, where the original submitter gathered
>>> +agreements from the participants of the discussion and sent the final
>>> +"we all agreed that this is the good version--please apply" patches
>>> +to the maintainer. In practice, this almost never happened. The flow
>>> +described above reflects the reality much better and can be considered
>>> +the "canonical" procedure to get the patch accepted to the project.
>
> I actually was expecting to hear more comments about this paragraph,
> which makes a lame excuse for naming the section "A not-so ideal".
> After sleeping on it, I think it belongs to the log message of this
> change, not here. Future wanna-be developers do not have to know
> what process we wanted to have---they benefit from reading what the
> process _is_ in practice in a more direct way.
>
>>> +In the following sections, many techniques and conventions are listed
>>> +to help your patches get reviewed effectively.
>
> Thanks.
Thanks
[1]: https://lore.kernel.org/git/xmqqy18lpoqg.fsf@gitster.g/
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 690 bytes --]
next prev parent reply other threads:[~2024-05-10 19:09 UTC|newest]
Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-15 23:20 [RFC PATCH] doc: describe the project's decision-making process Josh Steadmon
2024-04-16 0:24 ` Junio C Hamano
2024-04-22 21:10 ` Josh Steadmon
2024-04-22 21:30 ` Junio C Hamano
2024-04-23 22:41 ` Junio C Hamano
2024-04-17 16:32 ` Enrico Mrass
2024-04-17 16:58 ` Junio C Hamano
2024-05-03 14:45 ` Junio C Hamano
2024-05-03 15:48 ` Josh Steadmon
2024-05-03 18:08 ` Junio C Hamano
2024-05-03 19:29 ` Taylor Blau
2024-05-06 7:12 ` Patrick Steinhardt
2024-05-06 20:14 ` Taylor Blau
2024-05-06 19:36 ` Josh Steadmon
2024-05-06 20:17 ` Taylor Blau
2024-04-22 18:41 ` Emily Shaffer
2024-04-22 19:18 ` Junio C Hamano
2024-04-22 21:12 ` Emily Shaffer
2024-04-23 1:10 ` Junio C Hamano
2024-05-09 0:01 ` [PATCH v2] " Josh Steadmon
2024-05-09 18:10 ` Junio C Hamano
2024-05-09 19:20 ` Junio C Hamano
2024-05-09 21:13 ` [PATCH 0/2] Describe patch-flow better in SubmittingPatches Junio C Hamano
2024-05-09 21:13 ` [PATCH 1/2] SubmittingPatches: move the patch-flow section earlier Junio C Hamano
2024-05-09 21:13 ` [PATCH 2/2] SubmittingPatches: extend the "flow" section Junio C Hamano
2024-05-10 10:08 ` Karthik Nayak
2024-05-10 15:59 ` Junio C Hamano
2024-05-10 19:09 ` Karthik Nayak [this message]
2024-05-10 16:55 ` [PATCH v2 0/2] Describe life cycle of a patch series Junio C Hamano
2024-05-10 16:55 ` [PATCH v2 1/2] SubmittingPatches: move the patch-flow section earlier Junio C Hamano
2024-05-10 16:55 ` [PATCH v2 2/2] SubmittingPatches: extend the "flow" section Junio C Hamano
2024-05-10 16:56 ` [PATCH] decisions: focus on larger scale issues Junio C Hamano
2024-05-15 20:36 ` Josh Steadmon
2024-05-15 20:50 ` Junio C Hamano
2024-05-15 20:35 ` [PATCH v2 0/2] Describe life cycle of a patch series Josh Steadmon
2024-05-16 21:20 ` [PATCH v3] doc: describe the project's decision-making process Josh Steadmon
2024-05-16 22:01 ` Junio C Hamano
2024-05-17 20:18 ` Josh Steadmon
2024-05-17 6:29 ` Patrick Steinhardt
2024-05-17 16:40 ` Junio C Hamano
2024-05-21 5:56 ` Patrick Steinhardt
2024-05-17 20:35 ` [PATCH v4] " Josh Steadmon
2024-05-17 22:12 ` Junio C Hamano
2024-05-21 5:58 ` Patrick Steinhardt
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAOLa=ZRQGFPVD04n_3r5VjHjkxF4bWrW6Po7DyRVfeO9v08TXA@mail.gmail.com' \
--to=karthik.188@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).