From nobody Sat Feb 11 00:30:37 2023 X-Original-To: dev-commits-doc-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 4PDBMx67mxz3nbDp for ; Sat, 11 Feb 2023 00:30:37 +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 4PDBMx5jKDz4Jb7; Sat, 11 Feb 2023 00:30:37 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1676075437; 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=NoQ+rloBPBYAmAMZ3qbroVpTr0VJQAXg+27if9HHUrk=; b=syxPlKpdsib+YoAQdE0ZF8xCWHM86akH3FpEV93H4vwJdNGB3e3Ue36DeLblrwexLEgXzw BX9n4Amcrh+OsG6f1xWaPz2mdTPoi5FcSLpqPiXdsLUS4b59cVKU5vkpJ5LeZSINmdSYHp +GmIzFWUhgzICn+hta0jwqtntjg6SRG+qEitquu7s2nb99FOyWoYmmkEDbpziqfrgp/k9G 9Gp33PewCjFD9DLgwecQW1emvyH0oAdVyaTxPWBHQWoKKGq8CnQ9ApRg1FKt5xgFYva/S2 ocDLsgZT088lkA0rUoeb1PC5PM6vbdKfiNZTkGSQLGnXmwzgUIl6XjhG9vCFWA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1676075437; 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=NoQ+rloBPBYAmAMZ3qbroVpTr0VJQAXg+27if9HHUrk=; b=ctyTMcfhoOUi1WJ8MrGdVYNWI+J6t8hCE+wqJXyIlKVFZmNnLm2Z5btQ+a76FMU3iITNt6 3RSC8WYCwCIa/ylgz/+MYizYBMRLvuaSX0DsDjIB3KL4y380iz11t9DsK3fcOH/qmzyMYY X3ZouKkN30r02jojZSRmEsseBbGWnBrWHJ7XJxxdxsn/Nwk+3SD4hBTAQ8joyEt12ceOID Cbcpw1v8dc7FqPZSfkbKUmFoNY0pYkr08M0C8mkJzvLm7MaenCqC+kPKttJZU5Szu+XZNZ OCBBpGujMeK91l2ud3DFaOqP4m1KOAEM320XVAqWpxlGgYgu6l6g7exnANgdgw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1676075437; a=rsa-sha256; cv=none; b=D1jZXRRpYWr54Uvy0L7v/1dohxP9TOgYSCWVDsq1f+zK6t6c6aPMGLcg3mYOuP7moB/oWe QN1dZ3w/fHcf0I1XA/DA06hlKr18iEsw7qFXdwP44Kbx4kflfEqkxVWLuyUYc/hdla2Kr/ T+szyKdQUSV1iw23kx1pPNeKyIuP0oiB3rv6NI+rqVRJqweMXKHWRmVIpscx6WR68X7tnI GAlZU4igqV/Ehx23GAL3LSzM43m9FpdFCCy1vX8EuhfRocYnKyQw40ldhfsrcLz50navsy dTnXNT5kzDcTrEBtrZtfH2MOKcbyuXWWOItWnONM9+DmkwoDWfihVokJlVkImw== 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 4PDBMx4msfzdZM; Sat, 11 Feb 2023 00:30:37 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 31B0UbkZ082631; Sat, 11 Feb 2023 00:30:37 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 31B0UbKS082630; Sat, 11 Feb 2023 00:30:37 GMT (envelope-from git) Date: Sat, 11 Feb 2023 00:30:37 GMT Message-Id: <202302110030.31B0UbKS082630@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Warner Losh Subject: git: ff7980250d - main - contributing: Start pointing people at github List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-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: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: ff7980250d5fa19009042c620ea76701d168e4cf Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by imp: URL: https://cgit.FreeBSD.org/doc/commit/?id=ff7980250d5fa19009042c620ea76701d168e4cf commit ff7980250d5fa19009042c620ea76701d168e4cf Author: Warner Losh AuthorDate: 2023-02-11 00:30:16 +0000 Commit: Warner Losh CommitDate: 2023-02-11 00:30:16 +0000 contributing: Start pointing people at github Start pointing people to submitting github pull requests for simple changes. Provide some guidance on what is a simple change. This is a continuation of earlier experiments with the best way to process patches. Sponsored by: Netflix Reviewed by: debdrup, brooks, allanjude Differential Revision: https://reviews.freebsd.org/D38382 --- .../content/en/articles/contributing/_index.adoc | 23 ++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/documentation/content/en/articles/contributing/_index.adoc b/documentation/content/en/articles/contributing/_index.adoc index cd889a2361..f4d6a9c657 100644 --- a/documentation/content/en/articles/contributing/_index.adoc +++ b/documentation/content/en/articles/contributing/_index.adoc @@ -147,6 +147,29 @@ An idea or suggestion of _general_ technical interest should be mailed to the {f Likewise, people with an interest in such things (and a tolerance for a _high_ volume of mail!) may subscribe to the {freebsd-hackers}. See extref:{handbook}[The FreeBSD Handbook, eresources-mail] for more information about this and other mailing lists. +If you are submitting a simple patch to the src repo, please consider submitting it to the project's GitHub mirror as https://github.com/freebsd/freebsd-src/pulls[a pull request]. +Suitable submissions should: + +* It is ready or nearly ready to be committed. A committer should be able to land this patch with less than 10 minutes of additional work. +* It passes all the GitHub CI jobs. +* You can respond to feedback quickly. +* It touches fewer than about 10 files and the changes are less than about 200 lines. Changes larger than this may be OK, or you may be asked to submit multiple pull requests of a more manageable size. +* Each logical change is a separate commit within the pull request. Commit messages for each change should follow extref:{committers-guide}#commit-log-message[commit log guide]. +* All commits have your name and valid email address as you'd like to see them in the FreeBSD repository as the author. Fake github.com addresses cannot be used. +* The scope of the pull request should not change during review. If the review suggests changes that expand the scope, please create an independent pull request. +* 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 https://developercertificate.org/[Developer Certificate of Origin]. + +When updating pull request, please rebase with a forced push rather than a merge commit. +More complex changes may be submitted as pull requests, but they may be closed if they are too large, too unwieldy, become inactive, need further discussion in the community, or need extensive revision. +Please avoid creating large, wide-ranging cleanup patches: they are too large and lack the focus needed for a good review. +Misdirected patches may be redirected to a more appropriate forum for the patch to be resolved. + +Pull requests submitted to the ports repository may or may not see action, based on the whims of developers. +For now, you will have a better experience if you follow the ports submission process <>. + +The docs team also accepts pull requests via GitHub, but has not established any policy for them yet. + If you find a bug or are submitting a specific change, please report it using the https://bugs.FreeBSD.org/submit/[bug submission form]. Try to fill-in each field of the bug report. Unless they exceed 65KB, include any patches directly in the report.