diff --git a/documentation/content/en/articles/contributing/_index.adoc b/documentation/content/en/articles/contributing/_index.adoc --- a/documentation/content/en/articles/contributing/_index.adoc +++ b/documentation/content/en/articles/contributing/_index.adoc @@ -147,6 +147,22 @@ 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 https://github.com/freebsd/freebsd-src/pulls[github mirror] as a pull request (not as an issue, those are automatically closed). +A patch is simple if: + +* 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. Each change should have a good commit message. See extref:{committers-guide}#commit-log-message[commit log guide] for guidance. +* All commits have your name and valid email address as you'd like to see them in the FreeBSD repository as the author. Author names with the fake github.com addresses cannot be used. +* The scope of the pull request shouldn't change during review. If the review suggests changes that expand the scope, please make an independent serparate pull request. + +Please rebase with a forced push rather than doing a merge commit to update. +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, as large cleanup patches have proven difficult to mange in the past. +Misdirected patches may be redirected to a more appropriate forum for the patch to be resolved. + 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.