diff options
| author | Warner Losh <imp@FreeBSD.org> | 2023-12-28 00:16:33 +0000 |
|---|---|---|
| committer | Warner Losh <imp@FreeBSD.org> | 2023-12-28 00:16:33 +0000 |
| commit | 9c1335cead4ff07faf257d0b9003f9e6227be150 (patch) | |
| tree | 07ff88e2f5581f17bc3759ca62a84d03241bc7c4 /CONTRIBUTING.md | |
| parent | 4ea5e107b1e778321f2e5e5083cf4eee3888eca8 (diff) | |
| download | src-9c1335cead4ff07faf257d0b9003f9e6227be150.tar.gz src-9c1335cead4ff07faf257d0b9003f9e6227be150.zip | |
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.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 8 |
1 files changed, 7 insertions, 1 deletions
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: \<bugnumber\>' 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. |