From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on atuin.qyliss.net X-Spam-Level: X-Spam-Status: No, score=-4.6 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,RCVD_IN_DNSWL_LOW,SPF_HELO_PASS, T_SCC_BODY_TEXT_LINE autolearn=unavailable autolearn_force=no version=3.4.6 Received: from atuin.qyliss.net (localhost [IPv6:::1]) by atuin.qyliss.net (Postfix) with ESMTP id DFC83250A4; Wed, 10 Aug 2022 12:56:53 +0000 (UTC) Received: by atuin.qyliss.net (Postfix, from userid 496) id 335E12509D; Wed, 10 Aug 2022 12:56:51 +0000 (UTC) Received: from wout2-smtp.messagingengine.com (wout2-smtp.messagingengine.com [64.147.123.25]) by atuin.qyliss.net (Postfix) with ESMTPS id 6724324FFE for ; Wed, 10 Aug 2022 12:56:47 +0000 (UTC) Received: from compute5.internal (compute5.nyi.internal [10.202.2.45]) by mailout.west.internal (Postfix) with ESMTP id C5CAA3200929; Wed, 10 Aug 2022 08:56:44 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute5.internal (MEProxy); Wed, 10 Aug 2022 08:56:45 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=alyssa.is; h=cc :cc:content-transfer-encoding:content-type:date:date:from:from :in-reply-to:message-id:mime-version:reply-to:sender:subject :subject:to:to; s=fm3; t=1660136204; x=1660222604; bh=X/9Sv9i3Jv OaPrjBvxNeBzHOp100CV5oAiv6E6jT7Mg=; b=hlgWalQgoq7vTxgRN3NWTiVatc 1wi16ciaA5DzxaU/ixpfJwU4OKxxFmiOJuuYuV8A/4fGjT/h2jZpQuLSum8FMiWZ l7GKvDwwQpHt2kteZSv0b9T1qvsE33tuw9R6suGFuqNsrhWRmcnNGjWvw4AGBaSG uKVavjMdacUVZt8B2WPU5bDLmclJ3x3r2u/v74npafEE4MIQDPnTXAFkj3K/YTWL 0yh6PtMNlFP7k6+ogslkOKgMDB5sZTrj+PhVz8qY/GTA9we42TlO6lagamn2oIwe IGLS1OOh9l6D0/FY5cT7SsnudGFm3eOaymzydVQIJkCx8uQi5yGbpTGvp6mA== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding :content-type:date:date:feedback-id:feedback-id:from:from :in-reply-to:message-id:mime-version:reply-to:sender:subject :subject:to:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm1; t=1660136204; x=1660222604; bh=X/9Sv9i3JvOaP rjBvxNeBzHOp100CV5oAiv6E6jT7Mg=; b=MzYM02EoZ/LHAjXwJ90yZ3aaxFYwU EUuMaZ+kCw4XTxmwkm5Y1CExzEd/RwYF0N3MiSahMHbT2k14fcUBsKQiUguOIWGI B5xWhYG7qstxnoG6Jiy6ZC7d9GQagsH8Fz5t08/CsxEobFApQOo2pk4AEURdarYZ u68xW6eIc+mJOyGs85ZhDGKVHY0eP+h3sUWNhFmd+k3AV3xtLEpoAou4b47Hzhik dukG5ioMlQeqVz+Esnet4LVw7rioB9cnRimP1P8AbALuDnmPUQY2T+67hOWPH1tH 4rzCpmogzQsWV3rZ+mDBtMyYyCuaqAAivzuQ+sP1VVYgr+5BWyV8ypBAQ== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvfedrvdegvddgheehucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhephffvvefufffkofggtgfgsehtkeertdertdejnecuhfhrohhmpeetlhihshhs rgcutfhoshhsuceohhhisegrlhihshhsrgdrihhsqeenucggtffrrghtthgvrhhnpeeiff eluedvvdekleekgeeufefguedufeekgffgjeekkeeuveeihfegiedujeevffenucffohhm rghinhepshhpvggtthhruhhmqdhoshdrohhrghdpghhithdqshgtmhdrtghomhdpghhith dqshgvnhguqdgvmhgrihhlrdhiohdpghhithdqrhgvsggrshgvrdhiohenucevlhhushht vghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpehqhihlihhsshesvghvvg drqhihlhhishhsrdhnvght X-ME-Proxy: Feedback-ID: i12284293:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Wed, 10 Aug 2022 08:56:43 -0400 (EDT) Received: by eve.qyliss.net (Postfix, from userid 1000) id F20386B8; Wed, 10 Aug 2022 12:56:38 +0000 (UTC) From: Alyssa Ross To: devel@spectrum-os.org Subject: [PATCH] Documentation: add "Sending your First Patch" Date: Wed, 10 Aug 2022 12:54:06 +0000 Message-Id: <20220810125405.1133177-1-hi@alyssa.is> X-Mailer: git-send-email 2.35.1 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Message-ID-Hash: FVB4BN3PIO3EIGGBZ5VGLU73ZYWQ37OP X-Message-ID-Hash: FVB4BN3PIO3EIGGBZ5VGLU73ZYWQ37OP X-MailFrom: qyliss@eve.qyliss.net X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1; header-match-devel.spectrum-os.org-0; header-match-devel.spectrum-os.org-1; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header CC: Ville Ilvonen X-Mailman-Version: 3.3.5 Precedence: list List-Id: Patches and low-level development discussion Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: I think having this written down in tutorial style is important, so people can follow through some step by step instructions. We already have some similar documentation on , but it doesn't really go into any detail, and I think this belongs in the main documentation. Signed-off-by: Alyssa Ross --- Ville, I'm CCing you in case you'd like to review, since we talked about documenting the patch workflow a bit better before. We also have this small document about reviewing patches on the list now, at . :) Documentation/first-patch.adoc | 96 ++++++++++++++++++++++++++++++++++ 1 file changed, 96 insertions(+) create mode 100644 Documentation/first-patch.adoc diff --git a/Documentation/first-patch.adoc b/Documentation/first-patch.adoc new file mode 100644 index 0000000..22140e4 --- /dev/null +++ b/Documentation/first-patch.adoc @@ -0,0 +1,96 @@ += Sending Your First Patch +:page-parent: Tutorials + +// SPDX-FileCopyrightText: 2022 Unikie +// SPDX-License-Identifier: GFDL-1.3-no-invariants-or-later OR CC-BY-SA-4.0 + +== Prerequisites + +This tutorial assumes that you already have basic +https://git-scm.com/[git] experience. + +Before beginning, you'll need to have a local git checkout of the +https://spectrum-os.org/git/[Spectrum source tree]. You'll also need +to have configured `git send-email` — a guide for this can be found at +https://git-send-email.io/. + +== Making your changes + +If you've worked on any git repository before, the process for making +your changes will probably be very familiar. + +1. Create a branch for your changes: ++ +---- +git checkout -b fix-docs # for example +---- +2. Make changes in your editor. +3. Stage and commit your changes: ++ +---- +git add Documentation/first-patch.adoc # for example +git commit -s +---- ++ +TIP: The `-s` option adds a `Signed-off-by` line to the commit. This +indicates your acceptance of the +https://spectrum-os.org/git/spectrum/tree/DCO-1.1.txt[Developer's +Certificate of Origin], which is mandatory for Spectrum patches. + +== Submitting changes + +Once you're happy with how the commits on your branch look, run: + +---- +git send-email --to devel@spectrum-os.org --confirm=always origin/main +---- + +For each message, you will be prompted for confirmation, and then the +change will be submitted to the Spectrum development mailing list. +They will appear shortly on the +https://spectrum-os.org/lists/hyperkitty/list/devel@spectrum-os.org/[web +interface]. + +[#cover-letter] +TIP: If you're submitting multiple changes, and you'd like to provide +an overall description for the whole series, you can add the +`--compose` option, which will prompt you to compose a "cover letter" +message that will be sent before all of your patches. + +== Feedback + +Once your patch has been submitted, wait for it to be reviewed. +Feedback, if any, will be sent as email replies to your submitted +patch. You can respond to feedback in your mail client. Please use +the Reply All button to ensure that your messages are sent to the +mailing list as well as to the person who sent the feedback. + +If you need to make changes to your patch, and submit a new version, +use https://git-rebase.io/[`git rebase`] to create a new version of +your patch(es), and submit it like this: + +---- +git send-email -v2 --to devel@spectrum-os.org --confirm=always origin/main +---- + +The added `-v2` flag indicates that this is version two of your +patch set. If your patches require more rounds of changes, submit +subsequent rounds with `-v3`, `-v4`, etc. as appropriate. + +If you'd like to describe what has changed from the previous version +of your patches, you can do so in a xref:cover-letter[cover letter] +as described above. + +== Acceptance + +Once your patch has been accepted, it will be applied to the upstream +Spectrum git repository. You will receive an automated email +confirmation when this happens. + +== Questions + +If you have any questions about the patch submission process, you can +ask them either on the +https://spectrum-os.org/participating.html#spectrum-devel[development +mailing list], or in the +https://spectrum-os.org/participating.html#irc[IRC/Matrix channel]. -- 2.35.1