From patchwork Wed Oct 12 12:11:49 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 614561 Delivered-To: patch@linaro.org Received: by 2002:a17:522:c983:b0:460:3032:e3c4 with SMTP id kr3csp3227565pvb; Wed, 12 Oct 2022 05:13:42 -0700 (PDT) X-Google-Smtp-Source: AMsMyM6m9mbztHSfy2ea8YbtRCRVCwRxOUWNxEqEuK3BlmAn3qNtB8PgzQTq+fXBN+08n3dewIBr X-Received: by 2002:a05:620a:4483:b0:6ce:8e57:254b with SMTP id x3-20020a05620a448300b006ce8e57254bmr19787894qkp.540.1665576822416; Wed, 12 Oct 2022 05:13:42 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1665576822; cv=none; d=google.com; s=arc-20160816; b=UCh2uEZtlskZ+OLNK8CNaT2pbuDoJvuMG/u4wyE0v0vKwr3QswUrx9WNhG64Jpr6qE pidgORlJwrrN8mhZVV6VrkSwH3KVoZm4ARCJd3IvKWUJtq/VMlwa1GYS6dN5p0iyLnID u8LsMt+1CzHNXhRXYYekyqlrK2HY31/rlE9O30OzHE6g4uvUUQm+tVDW9d0AK6qwRb3S L8J1tIycV4SrQNY/VS1xxLbs+J4USMjNjICns5LfbP9sc/p/y1uCYB3/3cNA3Jie0o/h Vc3VAw/vjhlFBTdp7utKkBvafSzMJegfJEtWw3ZRgi5GT0AkkhgmqHvXmP4OtXQq7UNW y5Bw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=L/NA9YqO2FgVjXPSvc5SGYaN0q7zDb+Qmax6Cp2I/ug=; b=b0Jq6ihRqZSFhk9BUNlpQMGgop6HWnz+Q3PCTGOVpakstU7a2vteURgrYHhOWDrJ3/ fO6bFC02eyW0f6mD8mQZmaqzNb/HIF44Qz45r4CMth8hrcXnrpcrmGCxJWnqoREdiqYn HjBOknVlu92YNcqLJWudMCwJ0nHbTPJZF99xsPKsRY6IDkn/FxPdXs4mV3sR+qU5T9Cn rIHAJwlomLpugviCTU4E8EWK1EW+rbrm67vlQJF5h37ayBX3oLj9x0227jSGL9CIJN5Q /Tivtte1zPKtjbo4BxgQRLIwsyOsPzGr4cdOOdrqeP91O1Y1+WICZ1Ra7R0mNIHt0Htf ZZ8Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=EGlO4wBH; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id c21-20020a05620a135500b006e6422f107csi4450525qkl.749.2022.10.12.05.13.42 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Wed, 12 Oct 2022 05:13:42 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=EGlO4wBH; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1]:45434 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oiacH-0006Wx-OM for patch@linaro.org; Wed, 12 Oct 2022 08:13:41 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:43470) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oiaad-0006SR-MH for qemu-devel@nongnu.org; Wed, 12 Oct 2022 08:12:01 -0400 Received: from mail-wr1-x429.google.com ([2a00:1450:4864:20::429]:42969) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1oiaab-0006TA-J5 for qemu-devel@nongnu.org; Wed, 12 Oct 2022 08:11:59 -0400 Received: by mail-wr1-x429.google.com with SMTP id bp11so13198568wrb.9 for ; Wed, 12 Oct 2022 05:11:56 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=L/NA9YqO2FgVjXPSvc5SGYaN0q7zDb+Qmax6Cp2I/ug=; b=EGlO4wBH+HAAmelgG8hiYNOJ8fMbkHnhodu8ZzNtZXaZhq+urLSoOeKIUKcOblws+p tm8jbrjkyR+QiSofxR79ZBvQFkbC3pGZ+xXzrsIo1Hgi2drs1EKlVwe+GCB/x+w1KdTs Cxipl1UaEp9kVCXpcgWItLb+tqfQZNTDEUXopLMLFnOUgUfC8+xR0O8rrtm0YFyT+N/T CMRGpZIIzo8mn3FItolChknzIY6sJJ1E4n/cBiuoJ15bd/eNeTq753+d8miJcG73MZZA U7SDGfblhOhCwAuWeIBqREyOql7f7c4UJVbEwb5VdRCq8z8w7X1LzuQ+CgQ7ibQ6+QLt Po5w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=L/NA9YqO2FgVjXPSvc5SGYaN0q7zDb+Qmax6Cp2I/ug=; b=Y1K6wrufn5hfq8QnqdoWBOAMQMXzbLLXy2n0E5TKPE85p5KwGNMuVxAeok5aR2sVis 6ef7Rb4DecLl1hxAeLuzDZPm/EpoK8k//lDIGBwEwD2PIcEiXVkIkUxX5egIIiwTLM5M peYih8FeadW+vt09+MgPuqdgdAfTojw0X1t1TIpeSD7cFh2z8B06S3xMj1AGsJ5KwuQn FnCg9vD63knWIssKlsgD5xmPPcnOQ+t0Wjdc+wO7hArJVnoIbbGU4srcBE73OsT92GqH hTQOhWPIcdwyoL3pYniEQoCo6c4KDFnuhIEk/2CLw4T5oFXKjM/ckJUNZ+j4lYXlQrWT FvWg== X-Gm-Message-State: ACrzQf12ufLzl4PZYlkBI0Nm+s7Q0vNzAlJNR2JBzXLccgDuIvxaaSj9 gZUsOcqYGwKIfLvBsBFzWpjPxQ== X-Received: by 2002:adf:dec3:0:b0:22e:6efe:7861 with SMTP id i3-20020adfdec3000000b0022e6efe7861mr18327375wrn.454.1665576715053; Wed, 12 Oct 2022 05:11:55 -0700 (PDT) Received: from zen.linaroharston ([185.81.254.11]) by smtp.gmail.com with ESMTPSA id co11-20020a0560000a0b00b00228d52b935asm14079089wrb.71.2022.10.12.05.11.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 12 Oct 2022 05:11:53 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id A2EB81FFB8; Wed, 12 Oct 2022 13:11:52 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: pbonzini@redhat.com, stefanha@redhat.com, peter.maydell@linaro.org, agraf@csgraf.de, =?utf-8?q?Alex_Benn=C3=A9e?= Subject: [RFC PATCH 1/4] docs/devel: add a maintainers section to development process Date: Wed, 12 Oct 2022 13:11:49 +0100 Message-Id: <20221012121152.1179051-2-alex.bennee@linaro.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20221012121152.1179051-1-alex.bennee@linaro.org> References: <20221012121152.1179051-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::429; envelope-from=alex.bennee@linaro.org; helo=mail-wr1-x429.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" We don't currently have a clear place in the documentation to describe the rolls and responsibilities of a maintainer. Lets create one so we can. I've moved a few small bits out of other files to try and keep everything in one place. Signed-off-by: Alex Bennée --- docs/devel/code-of-conduct.rst | 2 + docs/devel/index-process.rst | 1 + docs/devel/maintainers.rst | 84 ++++++++++++++++++++++++ docs/devel/submitting-a-pull-request.rst | 12 ++-- 4 files changed, 91 insertions(+), 8 deletions(-) create mode 100644 docs/devel/maintainers.rst diff --git a/docs/devel/code-of-conduct.rst b/docs/devel/code-of-conduct.rst index 195444d1b4..f734ed0317 100644 --- a/docs/devel/code-of-conduct.rst +++ b/docs/devel/code-of-conduct.rst @@ -1,3 +1,5 @@ +.. _code_of_conduct: + Code of Conduct =============== diff --git a/docs/devel/index-process.rst b/docs/devel/index-process.rst index d0d7a200fd..d50dd74c3e 100644 --- a/docs/devel/index-process.rst +++ b/docs/devel/index-process.rst @@ -8,6 +8,7 @@ Notes about how to interact with the community and how and where to submit patch code-of-conduct conflict-resolution + maintainers style submitting-a-patch trivial-patches diff --git a/docs/devel/maintainers.rst b/docs/devel/maintainers.rst new file mode 100644 index 0000000000..e3c7003bfa --- /dev/null +++ b/docs/devel/maintainers.rst @@ -0,0 +1,84 @@ +.. _maintainers: + +The Roll of Maintainers +======================= + +Maintainers are a critical part of the projects contributor ecosystem. +They come from a wide range of backgrounds from unpaid hobbyists +working in their spare time to employees who work on the project as +part of their job. Maintainer activities include: + + - reviewing patches and suggesting changes + - preparing pull requests for their subsystems + - participating other project activities + +They are also human and subject to the same pressures as everyone else +including overload and burn out. Like everyone else they are subject +to projects :ref:`code_of_conduct`. + +The MAINTAINERS file +-------------------- + +The `MAINTAINERS +`__ +file contains the canonical list of who is a maintainer. The file +is machine readable so an appropriately configured git (see +:ref:`cc_the_relevant_maintainer`) can automatically Cc them on +patches that touch their area of code. + +The file also describes the status of the area of code to give an idea +of how actively that section is maintained. + +.. list-table:: Meaning of support status in MAINTAINERS + :widths: 25 75 + :header-rows: 1 + + * - Status + - Meaning + * - Supported + - Someone is actually paid to look after this. + * - Maintained + - Someone actually looks after it. + * - Odd Fixes + - It has a maintainer but they don't have time to do + much other than throw the odd patch in. + * - Orphan + - No current maintainer. + * - Obsolete + - Old obsolete code, should use something else. + +Please bare in mind that even if someone is paid to support something +it does not mean they are paid to support you. This is open source and +the code comes with no warranty and the project makes no guarantees +about dealing with bugs or features requests. + +Becoming a maintainer +--------------------- + +Maintainers are volunteers who put themselves forward to keep an eye +on an area of code. They are generally accepted by the community to +have a good understanding of the subsystem and able to make a positive +contribution to the project. + +The process is simple - simply sent a patch to the list that updates +the ``MAINTAINERS`` file. Sometimes this is done as part of a larger +series when a new sub-system is being added to the code base. This can +also be done by a retiring maintainer who nominates their replacement +after discussion with other contributors. + +Once the patch is reviewed and merged the only other step is to make +sure your GPG key is signed. + +.. _maintainer_keys: + +Maintainer GPG Keys +~~~~~~~~~~~~~~~~~~~ + +GPG is used to sign pull requests so they can be identified as really +coming from the maintainer. If your key is not already signed by +members of the QEMU community, you should make arrangements to attend +a `KeySigningParty `__ (for +example at KVM Forum) or make alternative arrangements to have your +key signed by an attendee. Key signing requires meeting another +community member **in person** so please make appropriate +arrangements. diff --git a/docs/devel/submitting-a-pull-request.rst b/docs/devel/submitting-a-pull-request.rst index c9d1e8afd9..a4cd7ebbb6 100644 --- a/docs/devel/submitting-a-pull-request.rst +++ b/docs/devel/submitting-a-pull-request.rst @@ -53,14 +53,10 @@ series) and that "make check" passes before sending out the pull request. As a submaintainer you're one of QEMU's lines of defense against bad code, so double check the details. -**All pull requests must be signed**. If your key is not already signed -by members of the QEMU community, you should make arrangements to attend -a `KeySigningParty `__ (for -example at KVM Forum) or make alternative arrangements to have your key -signed by an attendee. Key signing requires meeting another community -member \*in person\* so please make appropriate arrangements. By -"signed" here we mean that the pullreq email should quote a tag which is -a GPG-signed tag (as created with 'gpg tag -s ...'). +**All pull requests must be signed**. By "signed" here we mean that +the pullreq email should quote a tag which is a GPG-signed tag (as +created with 'gpg tag -s ...'). See :ref:`maintainer_keys` for +details. **Pull requests not for master should say "not for master" and have "PULL SUBSYSTEM whatever" in the subject tag**. If your pull request is