From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: passt.top; dmarc=pass (p=quarantine dis=none) header.from=redhat.com Authentication-Results: passt.top; dkim=pass (1024-bit key; unprotected) header.d=redhat.com header.i=@redhat.com header.a=rsa-sha256 header.s=mimecast20190719 header.b=Tmeg8f2L; dkim-atps=neutral Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by passt.top (Postfix) with ESMTPS id 366485A0278 for ; Fri, 12 Sep 2025 09:54:38 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1757663677; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=SaeS9BLJM01pw1+k5H7NdEB7bOjRu/GuJdWDpWFz9KU=; b=Tmeg8f2Lbzrv057lKNmt3IUwx2Ti5ytgwRumLEPJtB+09xGcwZQE1zs+GSE94KrhlFaWIS EwirGHlv+Fp6k8kE68EpUECpfVXhU4LMP5HrNkjUUb5ac9pIOHwMdRAKMrqORT9+l6w0P7 pjCXbLkW0mIBOWGI+ddFAFgreQ3vxnM= Received: from mx-prod-mc-04.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-98-YfwU0mW0NnGRPaZ7SmPgxw-1; Fri, 12 Sep 2025 03:54:35 -0400 X-MC-Unique: YfwU0mW0NnGRPaZ7SmPgxw-1 X-Mimecast-MFC-AGG-ID: YfwU0mW0NnGRPaZ7SmPgxw_1757663674 Received: from mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.17]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id A012B19373DE; Fri, 12 Sep 2025 07:54:33 +0000 (UTC) Received: from fedora.redhat.com (unknown [10.72.112.58]) by mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id A48091954126; Fri, 12 Sep 2025 07:54:30 +0000 (UTC) From: Yumei Huang To: passt-dev@passt.top Subject: [PATCH] Add CONTRIBUTING.md Date: Fri, 12 Sep 2025 15:54:23 +0800 Message-ID: <20250912075423.19500-1-yuhuang@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.17 X-Mimecast-Spam-Score: 0 X-Mimecast-MFC-PROC-ID: iiIn8Nf8sZfBgj7nEKLIll5XFHOi2rXgUe2KX8xxCRM_1757663674 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit content-type: text/plain; charset="US-ASCII"; x-default=true Message-ID-Hash: QDIVZRRS6SFM6MWALRXY7S2UFYTWZLXL X-Message-ID-Hash: QDIVZRRS6SFM6MWALRXY7S2UFYTWZLXL X-MailFrom: yuhuang@redhat.com 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: sbrivio@redhat.com, david@gibson.dropbear.id.au, yuhuang@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: Signed-off-by: Yumei Huang --- CONTRIBUTING.md | 86 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 CONTRIBUTING.md 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. + +## 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 + + 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-...patch, etc. + +If you send a series of patches, use the `--cover-letter` option with `git 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=passt-dev@passt.top 000*.patch + +If there are CCs (e.g. maintainers, reviewers), you can add them with `--cc`: + + git send-email --to=passt-dev@passt.top --cc=maintainer@example.com 000*.patch + +### 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=passt-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 difference. -- 2.47.0