diff mbox series

[ovs-dev] Documentation: Update language about soft freeze requirements.

Message ID 20240702173816.1695872-1-mmichels@redhat.com
State Accepted
Headers show
Series [ovs-dev] Documentation: Update language about soft freeze requirements. | expand

Checks

Context Check Description
ovsrobot/apply-robot success apply and check: success
ovsrobot/github-robot-_Build_and_Test success github build: passed
ovsrobot/github-robot-_ovn-kubernetes fail github build: failed

Commit Message

Mark Michelson July 2, 2024, 5:38 p.m. UTC
The documentation stated that for soft freeze, the development team
would only consider merging new feature patches that had been "discussed
and reviewed" during the soft freeze period. In reality, the OVN team
has been willing to merge any new feature as long as it has been posted
for review prior to the soft freeze date. The emails sent out by the OVN
team prior to soft freeze have also stated that patches that were posted
for review were under consideration for merging.

To clear up confusion, the wording in the documentation has been updated
as well now to indicate that patches simply need to be "posted" rather
than being "discussed and reviewed" prior to the soft freeze date.

Signed-off-by: Mark Michelson <mmichels@redhat.com>
---
 Documentation/internals/release-process.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Ilya Maximets July 2, 2024, 5:51 p.m. UTC | #1
On 7/2/24 19:38, Mark Michelson wrote:
> The documentation stated that for soft freeze, the development team
> would only consider merging new feature patches that had been "discussed
> and reviewed" during the soft freeze period. In reality, the OVN team
> has been willing to merge any new feature as long as it has been posted
> for review prior to the soft freeze date. The emails sent out by the OVN
> team prior to soft freeze have also stated that patches that were posted
> for review were under consideration for merging.
> 
> To clear up confusion, the wording in the documentation has been updated
> as well now to indicate that patches simply need to be "posted" rather
> than being "discussed and reviewed" prior to the soft freeze date.
> 
> Signed-off-by: Mark Michelson <mmichels@redhat.com>
> ---
>  Documentation/internals/release-process.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/internals/release-process.rst b/Documentation/internals/release-process.rst
> index 988257975..2e9fa4f18 100644
> --- a/Documentation/internals/release-process.rst
> +++ b/Documentation/internals/release-process.rst
> @@ -45,9 +45,9 @@ Scheduling`_ for the timing of each stage:
>  1. "Soft freeze" of the main branch.
>  
>     During the freeze, we ask committers to refrain from applying patches that
> -   add new features unless those patches were already being publicly discussed
> -   and reviewed before the freeze began.  Bug fixes are welcome at any time.
> -   Please propose and discuss exceptions on ovs-dev.
> +   add new features unless those patches were already publicly posted before

'publicly posted' sounds a little strange...  Maybe 'posted for review' or
'posted for a public review'?

> +   the freeze began.  Bug fixes are welcome at any time. Please propose

Two spaces vs one space.  We should be consistent at least within the same
paragraph.

> +   and discuss exceptions on ovs-dev.
>   
>  2. Fork a release branch from main, named for the expected release number,
>     e.g. "branch-25.09" for the branch that will yield OVN 25.09.x.
Numan Siddique July 2, 2024, 8:51 p.m. UTC | #2
On Tue, Jul 2, 2024 at 1:51 PM Ilya Maximets <i.maximets@ovn.org> wrote:
>
> On 7/2/24 19:38, Mark Michelson wrote:
> > The documentation stated that for soft freeze, the development team
> > would only consider merging new feature patches that had been "discussed
> > and reviewed" during the soft freeze period. In reality, the OVN team
> > has been willing to merge any new feature as long as it has been posted
> > for review prior to the soft freeze date. The emails sent out by the OVN
> > team prior to soft freeze have also stated that patches that were posted
> > for review were under consideration for merging.
> >
> > To clear up confusion, the wording in the documentation has been updated
> > as well now to indicate that patches simply need to be "posted" rather
> > than being "discussed and reviewed" prior to the soft freeze date.
> >
> > Signed-off-by: Mark Michelson <mmichels@redhat.com>

Acked-by: Numan Siddique <numans@ovn.org>

Numan

> > ---
> >  Documentation/internals/release-process.rst | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
> >
> > diff --git a/Documentation/internals/release-process.rst b/Documentation/internals/release-process.rst
> > index 988257975..2e9fa4f18 100644
> > --- a/Documentation/internals/release-process.rst
> > +++ b/Documentation/internals/release-process.rst
> > @@ -45,9 +45,9 @@ Scheduling`_ for the timing of each stage:
> >  1. "Soft freeze" of the main branch.
> >
> >     During the freeze, we ask committers to refrain from applying patches that
> > -   add new features unless those patches were already being publicly discussed
> > -   and reviewed before the freeze began.  Bug fixes are welcome at any time.
> > -   Please propose and discuss exceptions on ovs-dev.
> > +   add new features unless those patches were already publicly posted before
>
> 'publicly posted' sounds a little strange...  Maybe 'posted for review' or
> 'posted for a public review'?
>
> > +   the freeze began.  Bug fixes are welcome at any time. Please propose
>
> Two spaces vs one space.  We should be consistent at least within the same
> paragraph.
>
> > +   and discuss exceptions on ovs-dev.
> >
> >  2. Fork a release branch from main, named for the expected release number,
> >     e.g. "branch-25.09" for the branch that will yield OVN 25.09.x.
>
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>
Dumitru Ceara July 3, 2024, 10:37 a.m. UTC | #3
On 7/2/24 22:51, Numan Siddique wrote:
> On Tue, Jul 2, 2024 at 1:51 PM Ilya Maximets <i.maximets@ovn.org> wrote:
>>
>> On 7/2/24 19:38, Mark Michelson wrote:
>>> The documentation stated that for soft freeze, the development team
>>> would only consider merging new feature patches that had been "discussed
>>> and reviewed" during the soft freeze period. In reality, the OVN team
>>> has been willing to merge any new feature as long as it has been posted
>>> for review prior to the soft freeze date. The emails sent out by the OVN
>>> team prior to soft freeze have also stated that patches that were posted
>>> for review were under consideration for merging.
>>>
>>> To clear up confusion, the wording in the documentation has been updated
>>> as well now to indicate that patches simply need to be "posted" rather
>>> than being "discussed and reviewed" prior to the soft freeze date.
>>>
>>> Signed-off-by: Mark Michelson <mmichels@redhat.com>
> 
> Acked-by: Numan Siddique <numans@ovn.org>
> 

I support this change too, thanks for fixing up the documentation, Mark!
 I'm OK with "posted for review" or "posted for a public review" if
that's more explicit (as Ilya points below).

Acked-by: Dumitru Ceara <dceara@redhat.com>

Regards,
Dumitru

> Numan
> 
>>> ---
>>>  Documentation/internals/release-process.rst | 6 +++---
>>>  1 file changed, 3 insertions(+), 3 deletions(-)
>>>
>>> diff --git a/Documentation/internals/release-process.rst b/Documentation/internals/release-process.rst
>>> index 988257975..2e9fa4f18 100644
>>> --- a/Documentation/internals/release-process.rst
>>> +++ b/Documentation/internals/release-process.rst
>>> @@ -45,9 +45,9 @@ Scheduling`_ for the timing of each stage:
>>>  1. "Soft freeze" of the main branch.
>>>
>>>     During the freeze, we ask committers to refrain from applying patches that
>>> -   add new features unless those patches were already being publicly discussed
>>> -   and reviewed before the freeze began.  Bug fixes are welcome at any time.
>>> -   Please propose and discuss exceptions on ovs-dev.
>>> +   add new features unless those patches were already publicly posted before
>>
>> 'publicly posted' sounds a little strange...  Maybe 'posted for review' or
>> 'posted for a public review'?
>>
>>> +   the freeze began.  Bug fixes are welcome at any time. Please propose
>>
>> Two spaces vs one space.  We should be consistent at least within the same
>> paragraph.
>>
>>> +   and discuss exceptions on ovs-dev.
>>>
>>>  2. Fork a release branch from main, named for the expected release number,
>>>     e.g. "branch-25.09" for the branch that will yield OVN 25.09.x.
>>
>> _______________________________________________
>> dev mailing list
>> dev@openvswitch.org
>> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>>
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
diff mbox series

Patch

diff --git a/Documentation/internals/release-process.rst b/Documentation/internals/release-process.rst
index 988257975..2e9fa4f18 100644
--- a/Documentation/internals/release-process.rst
+++ b/Documentation/internals/release-process.rst
@@ -45,9 +45,9 @@  Scheduling`_ for the timing of each stage:
 1. "Soft freeze" of the main branch.
 
    During the freeze, we ask committers to refrain from applying patches that
-   add new features unless those patches were already being publicly discussed
-   and reviewed before the freeze began.  Bug fixes are welcome at any time.
-   Please propose and discuss exceptions on ovs-dev.
+   add new features unless those patches were already publicly posted before
+   the freeze began.  Bug fixes are welcome at any time. Please propose
+   and discuss exceptions on ovs-dev.
  
 2. Fork a release branch from main, named for the expected release number,
    e.g. "branch-25.09" for the branch that will yield OVN 25.09.x.