Message ID | 20230213092616.3589932-1-jerinj@marvell.com (mailing list archive) |
---|---|
State | Superseded |
Headers |
Return-Path: <web-bounces@dpdk.org> X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id C708141C88; Mon, 13 Feb 2023 10:26:35 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 9255342C54; Mon, 13 Feb 2023 10:26:35 +0100 (CET) Received: from mx0b-0016f401.pphosted.com (mx0b-0016f401.pphosted.com [67.231.156.173]) by mails.dpdk.org (Postfix) with ESMTP id CC22D400D6; Mon, 13 Feb 2023 10:26:33 +0100 (CET) Received: from pps.filterd (m0045851.ppops.net [127.0.0.1]) by mx0b-0016f401.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 31D8HIIg031330; Mon, 13 Feb 2023 01:26:33 -0800 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h=from : to : cc : subject : date : message-id : mime-version : content-transfer-encoding : content-type; s=pfpt0220; bh=QXVlSWVvlxI9bqQk0HQ2Dg/y0y7SxIwntNlrj6frLtg=; b=EC4ooUJeZwF4xFOoFPw5aHZQ0MV6R+tYOoxXIMvlRRaC6zZ6kFa91WZpDPSJJtI+lUEY s05qldKH9/a6wVBWs8E5vpKxz/ljJVl67MFeakiZv0mp4igBPOMerBM4HvNrIi5g9kA5 ++K88hPXwdVgZVzj+yEh4wYBQyk54UWCpw3XPWHseFDTVJpt1agmM6J1MkNDqicmfhnN bVG9cZ7jXwDa50+UyU+MjYNoDLulOca0bI/ZRqBBAUmxnCYKUK6SBmT+4l7MYgqMbTp/ Joiqf2tVbVpf+YiukqTJWnhEzN1EN2+asOceusc9ASSdVNBw91oF5hWc1c+E2yHlJZE5 Vg== Received: from dc5-exch01.marvell.com ([199.233.59.181]) by mx0b-0016f401.pphosted.com (PPS) with ESMTPS id 3npbe1xnt2-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Mon, 13 Feb 2023 01:26:32 -0800 Received: from DC5-EXCH02.marvell.com (10.69.176.39) by DC5-EXCH01.marvell.com (10.69.176.38) with Microsoft SMTP Server (TLS) id 15.0.1497.42; Mon, 13 Feb 2023 01:26:30 -0800 Received: from maili.marvell.com (10.69.176.80) by DC5-EXCH02.marvell.com (10.69.176.39) with Microsoft SMTP Server id 15.0.1497.42 via Frontend Transport; Mon, 13 Feb 2023 01:26:30 -0800 Received: from jerin-lab.marvell.com (jerin-lab.marvell.com [10.28.34.14]) by maili.marvell.com (Postfix) with ESMTP id 55C013F704A; Mon, 13 Feb 2023 01:26:29 -0800 (PST) From: <jerinj@marvell.com> To: <web@dpdk.org> CC: <dev@dpdk.org>, <techboard@dpdk.org>, Jerin Jacob <jerinj@marvell.com> Subject: [dpdk-web] [RFC PATCH] process: new library approval in principle Date: Mon, 13 Feb 2023 14:56:16 +0530 Message-ID: <20230213092616.3589932-1-jerinj@marvell.com> X-Mailer: git-send-email 2.39.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Proofpoint-GUID: uqK82QFJCKnuFtZDOTS8c7FiDTSC1AVD X-Proofpoint-ORIG-GUID: uqK82QFJCKnuFtZDOTS8c7FiDTSC1AVD X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.219,Aquarius:18.0.930,Hydra:6.0.562,FMLib:17.11.170.22 definitions=2023-02-13_04,2023-02-09_03,2023-02-09_01 X-BeenThere: web@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK website maintenance <web.dpdk.org> List-Unsubscribe: <https://mails.dpdk.org/options/web>, <mailto:web-request@dpdk.org?subject=unsubscribe> List-Archive: <http://mails.dpdk.org/archives/web/> List-Post: <mailto:web@dpdk.org> List-Help: <mailto:web-request@dpdk.org?subject=help> List-Subscribe: <https://mails.dpdk.org/listinfo/web>, <mailto:web-request@dpdk.org?subject=subscribe> Errors-To: web-bounces@dpdk.org |
Series |
[RFC] process: new library approval in principle
|
|
Commit Message
Jerin Jacob
Feb. 13, 2023, 9:26 a.m. UTC
From: Jerin Jacob <jerinj@marvell.com> Based on TB meeting[1] action item, defining the process for new library approval in principle. [1] https://mails.dpdk.org/archives/dev/2023-January/260035.html Signed-off-by: Jerin Jacob <jerinj@marvell.com> --- content/process/_index.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 content/process/_index.md
Comments
On Mon, Feb 13, 2023 at 2:56 PM <jerinj@marvell.com> wrote: > > From: Jerin Jacob <jerinj@marvell.com> > > Based on TB meeting[1] action item, defining > the process for new library approval in principle. > > [1] > https://mails.dpdk.org/archives/dev/2023-January/260035.html Ping for review. > > Signed-off-by: Jerin Jacob <jerinj@marvell.com> > --- > content/process/_index.md | 33 +++++++++++++++++++++++++++++++++ > 1 file changed, 33 insertions(+) > create mode 100644 content/process/_index.md > > diff --git a/content/process/_index.md b/content/process/_index.md > new file mode 100644 > index 0000000..21c2642 > --- /dev/null > +++ b/content/process/_index.md > @@ -0,0 +1,33 @@ > ++++ > +title = "Process" > +weight = "9" > ++++ > + > +## Process for new library approval in principle > + > +### Rational > + > +Adding a new library to DPDK codebase with proper RFC and then full patch-sets is > +significant work and getting early approval-in-principle that a library help DPDK contributors > +avoid wasted effort if it is not suitable for various reasons. > + > +### Process > + > +1. When a contributor would like to add a new library to DPDK code base, the contributor must send > +the following items to DPDK mailing list for TB approval-in-principle. > + > + - Purpose of the library. > + - Scope of the library. > + - Any licensing constraints. > + - Justification for adding to DPDK. > + - Any other implementations of the same functionality in other libs/products and how this version differs. > + - Public API specification header file as RFC > + - Optional and good to have. > + - TB may additionally request this collateral if needed to get more clarity on scope and purpose. > + > +2. TB to schedule discussion on this in upcoming TB meeting along with author. Based on the TB > +schedule and/or author availability, TB may need maximum three TB meeting slots. > + > +3. Based on mailing list and TB meeting discussions, TB to vote for approval-in-principle and share > +the decision in the mailing list. > + > -- > 2.39.1 >
Thanks for formalizing our process. 13/02/2023 10:26, jerinj@marvell.com: > --- /dev/null > +++ b/content/process/_index.md First question: is the website the best place for this process? Inside the code guides, we have a contributing section, but I'm not sure it is a good fit for the decision process. In the website, you are creating a new page "process". Is it what we want? What about making it a sub-page of "Technical Board"? > @@ -0,0 +1,33 @@ > ++++ > +title = "Process" > +weight = "9" > ++++ > + > +## Process for new library approval in principle > + > +### Rational s/Rational/Rationale/ > + > +Adding a new library to DPDK codebase with proper RFC and then full patch-sets is > +significant work and getting early approval-in-principle that a library help DPDK contributors > +avoid wasted effort if it is not suitable for various reasons. That's a long sentence we could split. > + > +### Process > + > +1. When a contributor would like to add a new library to DPDK code base, the contributor must send > +the following items to DPDK mailing list for TB approval-in-principle. I think we can remove "code base". TB should be explained: Technical Board. > + > + - Purpose of the library. > + - Scope of the library. Not sure I understand the difference between Purpose and Scope. > + - Any licensing constraints. > + - Justification for adding to DPDK. > + - Any other implementations of the same functionality in other libs/products and how this version differs. libs/products -> libraries/projects > + - Public API specification header file as RFC > + - Optional and good to have. You mean providing API is optional at this stage? > + - TB may additionally request this collateral if needed to get more clarity on scope and purpose. > + > +2. TB to schedule discussion on this in upcoming TB meeting along with author. Based on the TB > +schedule and/or author availability, TB may need maximum three TB meeting slots. Better to translate the delay into weeks: 5 weeks? > + > +3. Based on mailing list and TB meeting discussions, TB to vote for approval-in-principle and share > +the decision in the mailing list. I think we should say here that it is safe to start working on the implementation after this step, but the patches will need to match usual quality criterias to be effectively accepted.
On Fri, Mar 3, 2023 at 11:55 PM Thomas Monjalon <thomas@monjalon.net> wrote: > > Thanks for formalizing our process. Thanks for the review. > > 13/02/2023 10:26, jerinj@marvell.com: > > --- /dev/null > > +++ b/content/process/_index.md > > First question: is the website the best place for this process? > > Inside the code guides, we have a contributing section, > but I'm not sure it is a good fit for the decision process. > > In the website, you are creating a new page "process". > Is it what we want? > What about making it a sub-page of "Technical Board"? Since it is a process, I thought of keeping "process" page. No specific opinion on where to add it. If not other objections, Then I can add at doc/guides/contributing/new_library_policy.rst in DPDK repo. Let me know if you think better name or better place to keep the file > > > @@ -0,0 +1,33 @@ > > ++++ > > +title = "Process" > > +weight = "9" > > ++++ > > + > > +## Process for new library approval in principle > > + > > +### Rational > > s/Rational/Rationale/ Ack > > > + > > +Adding a new library to DPDK codebase with proper RFC and then full patch-sets is > > +significant work and getting early approval-in-principle that a library help DPDK contributors > > +avoid wasted effort if it is not suitable for various reasons. > > That's a long sentence we could split. OK Changing as: Adding a new library to DPDK codebase with proper RFC and full patch-sets is significant work. Getting early approval-in-principle that a library can help DPDK contributors avoid wasted effort if it is not suitable for various reasons > > > + > > +### Process > > + > > +1. When a contributor would like to add a new library to DPDK code base, the contributor must send > > +the following items to DPDK mailing list for TB approval-in-principle. > > I think we can remove "code base". Ack > > TB should be explained: Technical Board. Ack > > > + > > + - Purpose of the library. > > + - Scope of the library. > > Not sure I understand the difference between Purpose and Scope. Purpose → The need for the library Scope → I meant the work scope associated with it. I will change "Scope of the library" to, - Scope of work: Outline the various additional tasks planned for this library, such as developing new test applications, adding new drivers, and updating existing applications. > > > + - Any licensing constraints. > > + - Justification for adding to DPDK. > > + - Any other implementations of the same functionality in other libs/products and how this version differs. > > libs/products -> libraries/projects Ack > > > + - Public API specification header file as RFC > > + - Optional and good to have. > > You mean providing API is optional at this stage? Yes. I think, TB can request if more clarity is needed as mentioned below. "TB may additionally request this collateral if needed to get more clarity on scope and purpose" > > > + - TB may additionally request this collateral if needed to get more clarity on scope and purpose. > > + > > +2. TB to schedule discussion on this in upcoming TB meeting along with author. Based on the TB > > +schedule and/or author availability, TB may need maximum three TB meeting slots. > > Better to translate the delay into weeks: 5 weeks? Ack > > > + > > +3. Based on mailing list and TB meeting discussions, TB to vote for approval-in-principle and share > > +the decision in the mailing list. > > I think we should say here that it is safe to start working > on the implementation after this step, > but the patches will need to match usual quality criterias > to be effectively accepted. OK. I will add the following, 4. Once TB approves the library in principle, it is safe to start working on its implementation. However, the patches will need to meet the usual quality criteria in order to be effectively accepted. > >
On Wed, Mar 15, 2023 at 7:17 PM Jerin Jacob <jerinjacobk@gmail.com> wrote: > > On Fri, Mar 3, 2023 at 11:55 PM Thomas Monjalon <thomas@monjalon.net> wrote: > > > > Thanks for formalizing our process. > > Thanks for the review. Ping > > > > > 13/02/2023 10:26, jerinj@marvell.com: > > > --- /dev/null > > > +++ b/content/process/_index.md > > > > First question: is the website the best place for this process? > > > > Inside the code guides, we have a contributing section, > > but I'm not sure it is a good fit for the decision process. > > > > In the website, you are creating a new page "process". > > Is it what we want? > > What about making it a sub-page of "Technical Board"? > > Since it is a process, I thought of keeping "process" page. > No specific opinion on where to add it. > If not other objections, Then I can add at > doc/guides/contributing/new_library_policy.rst in DPDK repo. > Let me know if you think better name or better place to keep the file > > > > > > @@ -0,0 +1,33 @@ > > > ++++ > > > +title = "Process" > > > +weight = "9" > > > ++++ > > > + > > > +## Process for new library approval in principle > > > + > > > +### Rational > > > > s/Rational/Rationale/ > > Ack > > > > > > + > > > +Adding a new library to DPDK codebase with proper RFC and then full patch-sets is > > > +significant work and getting early approval-in-principle that a library help DPDK contributors > > > +avoid wasted effort if it is not suitable for various reasons. > > > > That's a long sentence we could split. > > OK Changing as: > > Adding a new library to DPDK codebase with proper RFC and full > patch-sets is significant work. > > Getting early approval-in-principle that a library can help DPDK > contributors avoid wasted effort > if it is not suitable for various reasons > > > > > > > + > > > +### Process > > > + > > > +1. When a contributor would like to add a new library to DPDK code base, the contributor must send > > > +the following items to DPDK mailing list for TB approval-in-principle. > > > > I think we can remove "code base". > > Ack > > > > > TB should be explained: Technical Board. > > Ack > > > > > > + > > > + - Purpose of the library. > > > + - Scope of the library. > > > > Not sure I understand the difference between Purpose and Scope. > > Purpose → The need for the library > Scope → I meant the work scope associated with it. > > I will change "Scope of the library" to, > > - Scope of work: Outline the various additional tasks planned for this > library, such as developing new test applications, adding new drivers, > and updating existing applications. > > > > > > + - Any licensing constraints. > > > + - Justification for adding to DPDK. > > > + - Any other implementations of the same functionality in other libs/products and how this version differs. > > > > libs/products -> libraries/projects > > Ack > > > > > > + - Public API specification header file as RFC > > > + - Optional and good to have. > > > > You mean providing API is optional at this stage? > > Yes. I think, TB can request if more clarity is needed as mentioned below. > "TB may additionally request this collateral if needed to get more > clarity on scope and purpose" > > > > > > + - TB may additionally request this collateral if needed to get more clarity on scope and purpose. > > > + > > > +2. TB to schedule discussion on this in upcoming TB meeting along with author. Based on the TB > > > +schedule and/or author availability, TB may need maximum three TB meeting slots. > > > > Better to translate the delay into weeks: 5 weeks? > > Ack > > > > > > + > > > +3. Based on mailing list and TB meeting discussions, TB to vote for approval-in-principle and share > > > +the decision in the mailing list. > > > > I think we should say here that it is safe to start working > > on the implementation after this step, > > but the patches will need to match usual quality criterias > > to be effectively accepted. > > OK. > > I will add the following, > > 4. Once TB approves the library in principle, it is safe to start > working on its implementation. > However, the patches will need to meet the usual quality criteria in > order to be effectively accepted. > > > > > >
> rom: Jerin Jacob <jerinj at marvell.com> > > Based on TB meeting[1] action item, defining > the process for new library approval in principle. > > [1] > https://mails.dpdk.org/archives/dev/2023-January/260035.html > > Signed-off-by: Jerin Jacob <jerinj at marvell.com> > --- > content/process/_index.md | 33 +++++++++++++++++++++++++++++++++ > 1 file changed, 33 insertions(+) > create mode 100644 content/process/_index.md > > diff --git a/content/process/_index.md b/content/process/_index.md > new file mode 100644 > index 0000000..21c2642 > --- /dev/null > +++ b/content/process/_index.md > @@ -0,0 +1,33 @@ > ++++ > +title = "Process" > +weight = "9" > ++++ > + > +## Process for new library approval in principle > + > +### Rational > + > +Adding a new library to DPDK codebase with proper RFC and then full patch-sets is > +significant work and getting early approval-in-principle that a library help DPDK contributors > +avoid wasted effort if it is not suitable for various reasons. > + > +### Process > + > +1. When a contributor would like to add a new library to DPDK code base, the contributor must send > +the following items to DPDK mailing list for TB approval-in-principle. > + > + - Purpose of the library. > + - Scope of the library. I'd probably extend it to: Scope and expected usage models of the library. Apart from that - LGTM. Acked-by: Konstantin Ananyev <konstantin.v.ananyev@yandex.ru> > + - Any licensing constraints. > + - Justification for adding to DPDK. > + - Any other implementations of the same functionality in other libs/products and how this version differs. > + - Public API specification header file as RFC > + - Optional and good to have. > + - TB may additionally request this collateral if needed to get more clarity on scope and purpose. > + > +2. TB to schedule discussion on this in upcoming TB meeting along with author. Based on the TB > +schedule and/or author availability, TB may need maximum three TB meeting slots. > + > +3. Based on mailing list and TB meeting discussions, TB to vote for approval-in-principle and share > +the decision in the mailing list. > + > -- > 2.39.1
On Thu, Mar 30, 2023 at 6:18 PM Jerin Jacob <jerinjacobk@gmail.com> wrote: > > On Wed, Mar 15, 2023 at 7:17 PM Jerin Jacob <jerinjacobk@gmail.com> wrote: > > > > On Fri, Mar 3, 2023 at 11:55 PM Thomas Monjalon <thomas@monjalon.net> wrote: > > > > > > Thanks for formalizing our process. > > > > Thanks for the review. > > Ping @Thomas Monjalon Could you check the below comments and share your opinion to make forward progress. > > > > > > > > > 13/02/2023 10:26, jerinj@marvell.com: > > > > --- /dev/null > > > > +++ b/content/process/_index.md > > > > > > First question: is the website the best place for this process? > > > > > > Inside the code guides, we have a contributing section, > > > but I'm not sure it is a good fit for the decision process. > > > > > > In the website, you are creating a new page "process". > > > Is it what we want? > > > What about making it a sub-page of "Technical Board"? > > > > Since it is a process, I thought of keeping "process" page. > > No specific opinion on where to add it. > > If not other objections, Then I can add at > > doc/guides/contributing/new_library_policy.rst in DPDK repo. > > Let me know if you think better name or better place to keep the file > > > > > > > > > @@ -0,0 +1,33 @@ > > > > ++++ > > > > +title = "Process" > > > > +weight = "9" > > > > ++++ > > > > + > > > > +## Process for new library approval in principle > > > > + > > > > +### Rational > > > > > > s/Rational/Rationale/ > > > > Ack > > > > > > > > > + > > > > +Adding a new library to DPDK codebase with proper RFC and then full patch-sets is > > > > +significant work and getting early approval-in-principle that a library help DPDK contributors > > > > +avoid wasted effort if it is not suitable for various reasons. > > > > > > That's a long sentence we could split. > > > > OK Changing as: > > > > Adding a new library to DPDK codebase with proper RFC and full > > patch-sets is significant work. > > > > Getting early approval-in-principle that a library can help DPDK > > contributors avoid wasted effort > > if it is not suitable for various reasons > > > > > > > > > > > + > > > > +### Process > > > > + > > > > +1. When a contributor would like to add a new library to DPDK code base, the contributor must send > > > > +the following items to DPDK mailing list for TB approval-in-principle. > > > > > > I think we can remove "code base". > > > > Ack > > > > > > > > TB should be explained: Technical Board. > > > > Ack > > > > > > > > > + > > > > + - Purpose of the library. > > > > + - Scope of the library. > > > > > > Not sure I understand the difference between Purpose and Scope. > > > > Purpose → The need for the library > > Scope → I meant the work scope associated with it. > > > > I will change "Scope of the library" to, > > > > - Scope of work: Outline the various additional tasks planned for this > > library, such as developing new test applications, adding new drivers, > > and updating existing applications. > > > > > > > > > + - Any licensing constraints. > > > > + - Justification for adding to DPDK. > > > > + - Any other implementations of the same functionality in other libs/products and how this version differs. > > > > > > libs/products -> libraries/projects > > > > Ack > > > > > > > > > + - Public API specification header file as RFC > > > > + - Optional and good to have. > > > > > > You mean providing API is optional at this stage? > > > > Yes. I think, TB can request if more clarity is needed as mentioned below. > > "TB may additionally request this collateral if needed to get more > > clarity on scope and purpose" > > > > > > > > > + - TB may additionally request this collateral if needed to get more clarity on scope and purpose. > > > > + > > > > +2. TB to schedule discussion on this in upcoming TB meeting along with author. Based on the TB > > > > +schedule and/or author availability, TB may need maximum three TB meeting slots. > > > > > > Better to translate the delay into weeks: 5 weeks? > > > > Ack > > > > > > > > > + > > > > +3. Based on mailing list and TB meeting discussions, TB to vote for approval-in-principle and share > > > > +the decision in the mailing list. > > > > > > I think we should say here that it is safe to start working > > > on the implementation after this step, > > > but the patches will need to match usual quality criterias > > > to be effectively accepted. > > > > OK. > > > > I will add the following, > > > > 4. Once TB approves the library in principle, it is safe to start > > working on its implementation. > > However, the patches will need to meet the usual quality criteria in > > order to be effectively accepted. > > > > > > > > > >
On 13/02/2023 09:26, jerinj@marvell.com wrote: > From: Jerin Jacob <jerinj@marvell.com> > > Based on TB meeting[1] action item, defining > the process for new library approval in principle. > > [1] > https://mails.dpdk.org/archives/dev/2023-January/260035.html > > Signed-off-by: Jerin Jacob <jerinj@marvell.com> > --- > content/process/_index.md | 33 +++++++++++++++++++++++++++++++++ > 1 file changed, 33 insertions(+) > create mode 100644 content/process/_index.md > > diff --git a/content/process/_index.md b/content/process/_index.md > new file mode 100644 > index 0000000..21c2642 > --- /dev/null > +++ b/content/process/_index.md > @@ -0,0 +1,33 @@ > ++++ > +title = "Process" > +weight = "9" > ++++ > + > +## Process for new library approval in principle > + > +### Rational > + > +Adding a new library to DPDK codebase with proper RFC and then full patch-sets is > +significant work and getting early approval-in-principle that a library help DPDK contributors > +avoid wasted effort if it is not suitable for various reasons. > + > +### Process > + > +1. When a contributor would like to add a new library to DPDK code base, the contributor must send > +the following items to DPDK mailing list for TB approval-in-principle. > + > + - Purpose of the library. > + - Scope of the library. > + - Any licensing constraints. > + - Justification for adding to DPDK. > + - Any other implementations of the same functionality in other libs/products and how this version differs. - Dependencies (Need to know if it's introducing new dependencies to the project) > + - Public API specification header file as RFC > + - Optional and good to have. > + - TB may additionally request this collateral if needed to get more clarity on scope and purpose. > + > +2. TB to schedule discussion on this in upcoming TB meeting along with author. Based on the TB > +schedule and/or author availability, TB may need maximum three TB meeting slots. > + > +3. Based on mailing list and TB meeting discussions, TB to vote for approval-in-principle and share > +the decision in the mailing list. > + How about having three outcomes: - Approval in principal - Not approved - Further information needed
On Wed, Apr 19, 2023 at 9:10 PM Kevin Traynor <ktraynor@redhat.com> wrote: > > On 13/02/2023 09:26, jerinj@marvell.com wrote: > > From: Jerin Jacob <jerinj@marvell.com> > > > > Based on TB meeting[1] action item, defining > > the process for new library approval in principle. > > > > [1] > > https://mails.dpdk.org/archives/dev/2023-January/260035.html > > > > Signed-off-by: Jerin Jacob <jerinj@marvell.com> > > --- > > content/process/_index.md | 33 +++++++++++++++++++++++++++++++++ > > 1 file changed, 33 insertions(+) > > create mode 100644 content/process/_index.md > > > > diff --git a/content/process/_index.md b/content/process/_index.md > > new file mode 100644 > > index 0000000..21c2642 > > --- /dev/null > > +++ b/content/process/_index.md > > @@ -0,0 +1,33 @@ > > ++++ > > +title = "Process" > > +weight = "9" > > ++++ > > + > > +## Process for new library approval in principle > > + > > +### Rational > > + > > +Adding a new library to DPDK codebase with proper RFC and then full patch-sets is > > +significant work and getting early approval-in-principle that a library help DPDK contributors > > +avoid wasted effort if it is not suitable for various reasons. > > + > > +### Process > > + > > +1. When a contributor would like to add a new library to DPDK code base, the contributor must send > > +the following items to DPDK mailing list for TB approval-in-principle. > > + > > + - Purpose of the library. > > + - Scope of the library. > > + - Any licensing constraints. > > + - Justification for adding to DPDK. > > + - Any other implementations of the same functionality in other libs/products and how this version differs. > > - Dependencies > > (Need to know if it's introducing new dependencies to the project) Ack. I will add in next version. > > > + - Public API specification header file as RFC > > + - Optional and good to have. > > + - TB may additionally request this collateral if needed to get more clarity on scope and purpose. > > + > > +2. TB to schedule discussion on this in upcoming TB meeting along with author. Based on the TB > > +schedule and/or author availability, TB may need maximum three TB meeting slots. > > + > > +3. Based on mailing list and TB meeting discussions, TB to vote for approval-in-principle and share > > +the decision in the mailing list. > > + > > How about having three outcomes: > - Approval in principal > - Not approved > - Further information needed Ack. I will add in next version. >
17/04/2023 15:33, Jerin Jacob: > On Wed, Mar 15, 2023 at 7:17 PM Jerin Jacob <jerinjacobk@gmail.com> wrote: > > On Fri, Mar 3, 2023 at 11:55 PM Thomas Monjalon <thomas@monjalon.net> wrote: > @Thomas Monjalon Could you check the below comments and share your > opinion to make forward progress. > > > > 13/02/2023 10:26, jerinj@marvell.com: > > > > --- /dev/null > > > > +++ b/content/process/_index.md > > > > > > First question: is the website the best place for this process? > > > > > > Inside the code guides, we have a contributing section, > > > but I'm not sure it is a good fit for the decision process. > > > > > > In the website, you are creating a new page "process". > > > Is it what we want? > > > What about making it a sub-page of "Technical Board"? > > > > Since it is a process, I thought of keeping "process" page. > > No specific opinion on where to add it. > > If not other objections, Then I can add at > > doc/guides/contributing/new_library_policy.rst in DPDK repo. > > Let me know if you think better name or better place to keep the file Maybe that the contributing guide is the best place. I'm OK with a new file doc/guides/contributing/new_library.rst which could document more than the policy in future (like things to remember and to check). > > > > +Adding a new library to DPDK codebase with proper RFC and then full patch-sets is > > > > +significant work and getting early approval-in-principle that a library help DPDK contributors > > > > +avoid wasted effort if it is not suitable for various reasons. > > > > > > That's a long sentence we could split. > > > > OK Changing as: > > > > Adding a new library to DPDK codebase with proper RFC and full > > patch-sets is significant work. > > > > Getting early approval-in-principle that a library can help DPDK > > contributors avoid wasted effort > > if it is not suitable for various reasons It will be easier if starting with the goal: In order to save effort, developers will get an early approval in principle, or early feedback in case the library is not suitable for various reasons. > > > > > > > > + - Purpose of the library. > > > > + - Scope of the library. > > > > > > Not sure I understand the difference between Purpose and Scope. > > > > Purpose → The need for the library > > Scope → I meant the work scope associated with it. > > > > I will change "Scope of the library" to, > > > > - Scope of work: Outline the various additional tasks planned for this > > library, such as developing new test applications, adding new drivers, > > and updating existing applications. OK > > > > + - Public API specification header file as RFC > > > > + - Optional and good to have. > > > > > > You mean providing API is optional at this stage? > > > > Yes. I think, TB can request if more clarity is needed as mentioned below. > > "TB may additionally request this collateral if needed to get more > > clarity on scope and purpose" OK > > > > +3. Based on mailing list and TB meeting discussions, TB to vote for approval-in-principle and share > > > > +the decision in the mailing list. > > > > > > I think we should say here that it is safe to start working > > > on the implementation after this step, > > > but the patches will need to match usual quality criterias > > > to be effectively accepted. > > > > OK. > > > > I will add the following, > > > > 4. Once TB approves the library in principle, it is safe to start > > working on its implementation. > > However, the patches will need to meet the usual quality criteria in > > order to be effectively accepted. OK
diff --git a/content/process/_index.md b/content/process/_index.md new file mode 100644 index 0000000..21c2642 --- /dev/null +++ b/content/process/_index.md @@ -0,0 +1,33 @@ ++++ +title = "Process" +weight = "9" ++++ + +## Process for new library approval in principle + +### Rational + +Adding a new library to DPDK codebase with proper RFC and then full patch-sets is +significant work and getting early approval-in-principle that a library help DPDK contributors +avoid wasted effort if it is not suitable for various reasons. + +### Process + +1. When a contributor would like to add a new library to DPDK code base, the contributor must send +the following items to DPDK mailing list for TB approval-in-principle. + + - Purpose of the library. + - Scope of the library. + - Any licensing constraints. + - Justification for adding to DPDK. + - Any other implementations of the same functionality in other libs/products and how this version differs. + - Public API specification header file as RFC + - Optional and good to have. + - TB may additionally request this collateral if needed to get more clarity on scope and purpose. + +2. TB to schedule discussion on this in upcoming TB meeting along with author. Based on the TB +schedule and/or author availability, TB may need maximum three TB meeting slots. + +3. Based on mailing list and TB meeting discussions, TB to vote for approval-in-principle and share +the decision in the mailing list. +