From owner-svn-doc-head@freebsd.org Thu Aug 16 05:04:49 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id DEB07107D33D; Thu, 16 Aug 2018 05:04:48 +0000 (UTC) (envelope-from eadler@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 950528DDCB; Thu, 16 Aug 2018 05:04:48 +0000 (UTC) (envelope-from eadler@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 767E714D07; Thu, 16 Aug 2018 05:04:48 +0000 (UTC) (envelope-from eadler@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7G54mtB023902; Thu, 16 Aug 2018 05:04:48 GMT (envelope-from eadler@FreeBSD.org) Received: (from eadler@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7G54mN3023901; Thu, 16 Aug 2018 05:04:48 GMT (envelope-from eadler@FreeBSD.org) Message-Id: <201808160504.w7G54mN3023901@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: eadler set sender to eadler@FreeBSD.org using -f From: Eitan Adler Date: Thu, 16 Aug 2018 05:04:48 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52130 - head/en_US.ISO8859-1/articles/committers-guide X-SVN-Group: doc-head X-SVN-Commit-Author: eadler X-SVN-Commit-Paths: head/en_US.ISO8859-1/articles/committers-guide X-SVN-Commit-Revision: 52130 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 16 Aug 2018 05:04:49 -0000 Author: eadler Date: Thu Aug 16 05:04:47 2018 New Revision: 52130 URL: https://svnweb.freebsd.org/changeset/doc/52130 Log: [committer guide] update rules for contrib software. - Most notably don't require talking to core@ to take on maintainership. - Merge an FAQ into the main body of the text - Wordsmith - Remove references to CVS Approved by: core Modified: head/en_US.ISO8859-1/articles/committers-guide/article.xml Modified: head/en_US.ISO8859-1/articles/committers-guide/article.xml ============================================================================== --- head/en_US.ISO8859-1/articles/committers-guide/article.xml Wed Aug 15 21:05:01 2018 (r52129) +++ head/en_US.ISO8859-1/articles/committers-guide/article.xml Thu Aug 16 05:04:47 2018 (r52130) @@ -3185,10 +3185,7 @@ Relnotes: yes - Do not commit to anything under the - src/contrib, - src/crypto, or - src/sys/contrib trees without + Do not commit to contributed software without explicit approval from the respective maintainers. @@ -3495,34 +3492,38 @@ Relnotes: yes - Do not commit to anything under the - src/contrib, - src/crypto, and - src/sys/contrib trees without + Do not commit to contributed software without explicit approval from the respective maintainers. + Contributed software is anything under the + src/contrib, + src/crypto, or + src/sys/contrib trees. + The trees mentioned above are for contributed software usually imported onto a vendor branch. Committing - something there, even if it does not take the file off the - vendor branch, may cause unnecessary headaches for those - responsible for maintaining that particular piece of - software. Thus, unless you have - explicit approval from the maintainer - (or you are the maintainer), do not - commit there! + something there may cause unnecessary headaches + when importing newer versions of the software. As a + general consider sending patches upstream to the vendor. + Patches may be committed to FreeBSD first with permission + of the maintainer. - - Please note that this does not mean you should not try - to improve the software in question; you are still more - than welcome to do so. Ideally, submit your - patches to the vendor. If your changes are - &os;-specific, talk to the maintainer; they may be - willing to apply them locally. But whatever you do, do - not commit there by yourself! + Reasons for modifying upstream software range from + wanting strict control over a tightly coupled dependency + to lack of portability in the canonical + repository's distribution of their code. Regardless of the + reason, effort to minimize the maintenance burden of + fork is helpful to fellow maintainers. Avoid committing + trivial or cosmetic changes to files + since it makes every merge thereafter more + difficult: such patches need to be manually re-verified + every import. - Contact the &a.core; if you wish to take up - maintainership of an unmaintained part of the tree. + If a particular piece of software lacks a maintainer, + you're encouraged to take up owership. If you're unsure + of the current maintainership email &a.arch; and + ask. @@ -5088,28 +5089,6 @@ Do you want to commit? (no = start a shell) [y/n]Miscellaneous Questions - - - Why are trivial or cosmetic changes to files on a - vendor branch a bad idea? - - - - - - From now on, every new vendor release of that file - will need to have patches merged in by hand. - - - - From now on, every new vendor release of that file - will need to have patches - verified by hand. - - - - - How do I add a new file to a branch?