From nobody Thu Dec 28 00:23:54 2023 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4T0q4V4SFGz54hXd; Thu, 28 Dec 2023 00:23:54 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4T0q4V3XXjz3Fvg; Thu, 28 Dec 2023 00:23:54 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1703723034; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=4RGP2dRWguypIqdQecFY+KI5OHTWSeG9TYTW9f/2QwU=; b=DNUOfu6rrkDXOy4THb51UA9RQpt2LgtUTyUz3XckCjguBAlnXkbAiRxRXtS2qvH6i3dZCX gyLectQ3c5thHxEJyn5qhVsXWuuPjhn1SW/0Woa/JTuCD6WDmU+4zAxkG3DL+q4PFJIYGC b9nyuaY6WndQksfgBlVsaUVLyI0sVKkNwAAC7XWTFnAZ04UTdyBPoJj3qtv+mbe+ZJd3BH w7TCQdfUpxII3//vzBsTDDqAWNfKLo0Vk0KYafyt+lb7cxHN1vJ2X5uYQBAOfjjxT49wvz 25q7PWtjEdP6rHYZ/au+tnUJWZLg0U3OqSBIUazL+15SE0OgXnLOqSaFnA5kGQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1703723034; a=rsa-sha256; cv=none; b=nhOqyXfiu/ukLliY7c8JjbjUYtMhWaPMqjdJ5mVozO2ym0k/r/HkY1uy33YfUj5eH1lkzL zld15VgER+NsysOXNt5YmZNvFMIKOvaDyu5apcV+yDxFOY49FzyPDf0UjjZf5nxWm/w3R/ 67jPseH8TjrWBRBDH1B57lEdc63jnKH28Ybst5L0+CaYbuFlX/gTE4b0PAGsGg0tKVsMcw EwnynnbSgx3IyYNSkMFsm8M0qy/4mmGNHJFu5AubjBgfezWE5RrtIU4I3fEI51qmWDu1Lq KKysZdAzmtJuGklW63UEkI3xFxPVBhVHbcbfTjDUtkHN/mUZXG8JXEKq17QIbQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1703723034; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=4RGP2dRWguypIqdQecFY+KI5OHTWSeG9TYTW9f/2QwU=; b=KUjSLd50RQPyyfuiVcnjKF7lB1UQrl3xlf3qkHCB4ZQtLNiK+xlZhOG+NjU+3VEjdHGFAK mLl+Kxuv/CJmST+ldy42P8SkuIaStrlODZ1liQMk1CmdcxzADQs6Y5r9yZuEehU5HyLJhb JBrjg6BXM0d1rXiGYURJioXf+iul5vZW/zOHz9hYoE2wlGFYbQmASOXb9UktaqvXwveZ6/ 8ZiNirtOollEccImu/OnndZVISHJZIoSwuacRKt5XhCJxBZmZeB4m/9CzNxZtIPePXEBBE 3xbCBqwgaeJ5OymfhZT5h0UZ52y5Yg5CIf1QPqd1Aa/HJrUelG/p8g7++Da3fQ== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4T0q4V2ZNvz112w; Thu, 28 Dec 2023 00:23:54 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 3BS0NsGw073229; Thu, 28 Dec 2023 00:23:54 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 3BS0Nsuq073226; Thu, 28 Dec 2023 00:23:54 GMT (envelope-from git) Date: Thu, 28 Dec 2023 00:23:54 GMT Message-Id: <202312280023.3BS0Nsuq073226@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Warner Losh Subject: git: 9c1335cead4f - main - contributing: Add note about static analyzers List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: imp X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 9c1335cead4ff07faf257d0b9003f9e6227be150 Auto-Submitted: auto-generated The branch main has been updated by imp: URL: https://cgit.FreeBSD.org/src/commit/?id=9c1335cead4ff07faf257d0b9003f9e6227be150 commit 9c1335cead4ff07faf257d0b9003f9e6227be150 Author: Warner Losh AuthorDate: 2023-12-28 00:16:33 +0000 Commit: Warner Losh CommitDate: 2023-12-28 00:16:33 +0000 contributing: Add note about static analyzers Please don't submit the raw results of some static analysis. Please do submit the thoughtful results, though. Please test with kyua and create test cases for any actual bugs that might be fixed. --- CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 62a11d8498c3..907c0d131a6c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,10 +39,11 @@ A pull request will be considered if: * Fixup commits should be squashed with the commit they are fixing. Each commit in your branch should be suitable for FreeBSD's repository. * Commits should include one or more `Signed-off-by:` lines with full name and email address certifying [Developer Certificate of Origin](https://developercertificate.org/). * The commits follow FreeBSD's style guide. See [Style](#Style). -* Run tools/build/checkstyle9.pl on your Git branch and eliminate all errors +* Run tools/build/checkstyle9.pl on your Git branch and eliminate all errors. * The commits do not introduce trailing white space. * If the commmit fixes a bug, please add 'PR: \' to the commit message. * If there's a code review in Phabricator, please include a link as a 'Differential Revision: ' line. +* If you have run FreeBSD's sources through a static analysis tool, please don't submit the raw results. Please also see the chunking up guidelines. Also, please make sure that kyua tests are the same before / after your change. Ideally, you'd also create a test case that shows an actual bug that's being fixed by these changes. When updating your pull request, please rebase with a forced push rather than a merge commit. @@ -75,6 +76,11 @@ submission does not meet the limited scope for pull requests accepted here. Sometimes it is easier to review a GitHub pull request than to do the review in Phabricator, so that's also allowed. +Finally, if we close a pull request because it's not ready yet, or stalled out, +please don't give up. You can resubmit them later once you have time to finish +the work, or to have them reconsidered if you think we've made an error in +closing it. + ### Author Name and Email We require that contributions are associated with a unique identity.