From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: passt.top; dmarc=none (p=none dis=none) header.from=gibson.dropbear.id.au Authentication-Results: passt.top; dkim=pass (2048-bit key; secure) header.d=gibson.dropbear.id.au header.i=@gibson.dropbear.id.au header.a=rsa-sha256 header.s=202508 header.b=L/CBoIj1; dkim-atps=neutral Received: from mail.ozlabs.org (mail.ozlabs.org [IPv6:2404:9400:2221:ea00::3]) by passt.top (Postfix) with ESMTPS id DA5435A0279 for ; Mon, 15 Sep 2025 04:11:01 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gibson.dropbear.id.au; s=202508; t=1757902258; bh=lQktjWPy9xF5TSUhItEgsEtthj71/05u+HH0Oe7MtQs=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=L/CBoIj19G5R9TmbntlH/ySdquk7S4O9txmYClCsY+ZPv95g9noNUeYfoJvjM3riL IIGCu5M6ZW1C3NCDbdc2t/ChFG06V2FgQZeeOD8LrDi44vhEKvYupD2OkFsnQ47nCp XB6DeqvUYNylgETGBS5e9UvpEyOcdOHKhjpbZTDzWKlBnkhSyPd9DIjqxzrF5mL6SQ LDi1FU2ZBH91y30HhjLBvYj3txtvPR2XvuzG2n5829VCErT7m4KNsZYjt/T83wgib8 OAwnCbbirFGYjvE45n1e1W/rOiIcEvQxep3Uz+xlHDlxuFEGQkWDSTV6/QHOdSjFuk vwjtFSAbGMSsA== Received: by gandalf.ozlabs.org (Postfix, from userid 1007) id 4cQ7mf3bW4z4w1m; Mon, 15 Sep 2025 12:10:58 +1000 (AEST) Date: Mon, 15 Sep 2025 12:10:54 +1000 From: David Gibson To: Yumei Huang Subject: Re: [PATCH] Add CONTRIBUTING.md Message-ID: References: <20250912075423.19500-1-yuhuang@redhat.com> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha512; protocol="application/pgp-signature"; boundary="5/DG7p+aeMblx0As" Content-Disposition: inline In-Reply-To: <20250912075423.19500-1-yuhuang@redhat.com> Message-ID-Hash: ZEKTEGSCBLAPOGUY3T75UKHTQ2UJBODT X-Message-ID-Hash: ZEKTEGSCBLAPOGUY3T75UKHTQ2UJBODT X-MailFrom: dgibson@gandalf.ozlabs.org X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header CC: passt-dev@passt.top, sbrivio@redhat.com X-Mailman-Version: 3.3.8 Precedence: list List-Id: Development discussion and patches for passt Archived-At: Archived-At: List-Archive: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: --5/DG7p+aeMblx0As Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Fri, Sep 12, 2025 at 03:54:23PM +0800, Yumei Huang wrote: > Signed-off-by: Yumei Huang Nice first draft, but I think it will need some further work before being ready to merge. Here are some things that are probably worth adding: * Incorporate the information in the "Contribute" section of README.md (and change README to reference this document) * Code style conventions (kernel net-code) * The meaning of the "Signed-off-by" line (see kernel docs for full details or [0] or [1] for some simpler examples * Reference test/README.md for information on running the testsuite (that also needs updating) * Add a copyright and authorship banner (see README.md for an example) A few more minor comments below. [0] https://gitlab.com/dgibson/exeter/-/blob/main/CONTRIBUTING.md?ref_type=3Dhe= ads#developers-certificate-of-origin [1] https://github.com/dgibson/dtc/blob/main/CONTRIBUTING.md#developers-certifi= cate-of-origin > --- > CONTRIBUTING.md | 86 +++++++++++++++++++++++++++++++++++++++++++++++++ > 1 file changed, 86 insertions(+) > create mode 100644 CONTRIBUTING.md >=20 > diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md > new file mode 100644 > index 0000000..70e35b1 > --- /dev/null > +++ b/CONTRIBUTING.md > @@ -0,0 +1,86 @@ > +# Contributing to passt > + > +Thank you for your interest in contributing! This document explains how = to prepare patches and participate in the email-based review process. By convention we wrap Markdown files at 80 columns, so it's easier to read in text form. > + > +## Workflow > + > +### 1. Clone the project > + > + git clone git://passt.top/passt > + > +### 2. Create a Branch > + > + cd passt > + git checkout -b my-feature-branch > + > +Work on a separate branch instead of committing directly to `master`. > + > +### 3. Make Changes and Commit > + > +* Edit the source code or documentation. > + > +* Stage your changes: > + > + git add ... > + > +* Commit with a clear message containing `Signed-off-by:` tag: > + > + git commit -s =20 > + > + Commit message format: > + > + Subsystem: Brief summary (max ~50 chars) > + > + More detailed explanation if needed, wrapped at 72 chars. > + > + Signed-off-by: Your Name > + > + If there are some references, use "Links: " tag for simplicity. > + > +### 4. Generate Patches > + > +Use `git format-path` to generate patch(es): > + > + git format-patch origin/master > + > +This will generate numbered patch files such as 0001-...patch, 0002-...p= atch, etc. > + > +If you send a series of patches, use the `--cover-letter` option with `g= it format-patch`: > + > + git format-patch origin/main --cover-letter > + > +This will generate a cover letter besides your patches. You can edit the= cover letter before sending. > + > +### 5. Send Patches > + > +Use `git send-email` to send patches directly to the mailing list: > + > + git send-email --to=3Dpasst-dev@passt.top 000*.patch > + > +If there are CCs (e.g. maintainers, reviewers), you can add them with `-= -cc`: > + > + git send-email --to=3Dpasst-dev@passt.top --cc=3Dmaintainer@example.= com 000*.patch > + It might be worth mentioning git-publish (https://github.com/stefanha/git-publish) as an easier way of doing steps 4 & 5. > +### 6. Responding to Review Feedback > + > +* Be open to feedback on both code and documentation. > + > +* Update your patch as needed, and regenerate patches: > + > + git add ... > + git commit --amend > + git format-patch -v2 origin/master > + > +* Send the revised patches > + > + git send-email --to=3Dpasst-dev@passt.top v2-000*.patch > + > +### 7. Tips and Best Practices > + > +* Keep changes focused and easy to review. > + > +* Test your changes thoroughly. > + > +* Include documentation updates if your change affects usage or APIs. > + > +Thank you for helping improve passt! Your contributions make a big diffe= rence. > --=20 > 2.47.0 >=20 --=20 David Gibson (he or they) | I'll have my music baroque, and my code david AT gibson.dropbear.id.au | minimalist, thank you, not the other way | around. http://www.ozlabs.org/~dgibson --5/DG7p+aeMblx0As Content-Type: application/pgp-signature; name=signature.asc -----BEGIN PGP SIGNATURE----- iQIzBAEBCgAdFiEEO+dNsU4E3yXUXRK2zQJF27ox2GcFAmjHda0ACgkQzQJF27ox 2GdTeA/9G0pL8/bc4I9ZtczLBUjwL9cH/ot2VbVuZvxCIP3NXh3+AsUU4JXhiDxk gMiQifx/v5K88DUOHvtw5JxySmfJsgCITB7ZB/gqjOtZ5ned//2gxXafI+zYPMjF fYXlE0GCH4s0rJTOuYdGg7A48YiuEy1EG4W1I7pv965qmG8lnxjZWVbBaM0r7nFz u761huppcflTZBldGWAkS10Ch2IQcBuzw2cwf4QuewyTQLPLz31vKxeyHbirY7oO DlZeoTBKEleP+ueVc+SY6N0got0yRaEFH73hAqzgUbMjmwk5af742AAO4yrnqmMh uz8iw0W1oMF7ZO0qLba8HU4twsyyOuyeH+FaUWqmVsoJCQWCmvKOORdWQZgTRX3i sTMEhOGLa2AtXJEEnM9XLUC9+rcJp4piGSf9nwyD4Nc0kXyZJ/RjG63B4hx+fz+N xFkfu5okPS2S5rvp5AIjZSu2U3InoPzykprr8DxveMRbegQB/xpkEBvPRxfMpPW6 3BvaHBfl5NGLJBVKx+9ZZd1MubMkX3GRTA6xVouUZHsC82+3FBgBgMP3bKCFojkw wTo3LP7BbqXIy9etVAaDXui27UWExCJYENRldlDS6cYYTpUc7glD9ixZRhmIetI7 iQpUjcN2a5NfNaD9oAkay8urmga/grc+wDTH5mQ2JJk7zPNIbUk= =2X0i -----END PGP SIGNATURE----- --5/DG7p+aeMblx0As--