[Rpm-maint] [rpm-software-management/rpm] Improve documentation in files.cc and cpio.cc (.hh) (PR #4154)
Panu Matilainen
notifications at github.com
Wed Mar 18 10:20:36 UTC 2026
pmatilai left a comment (rpm-software-management/rpm#4154)
You're not alone missing bits from CONTRIBUTING, it often feels like it might as well not exist. FWIW we're thinking of some way to address that.
As for the PR itself, now that I did look:
- Random unrelated whitespace changes are not okay
- Adding comments after the fact is error prone at best, dangerous at worst. Comments, where appropriate at all (see CODING_STYLE.md) should describe the overall intent, not the details of what the code does. And subtly wrong or misleading comments are the worst of them all. The effort of us reviewing added comments is just not worth it.
I guess the above needs to go to CONTRIBUTING in some form as well.
--
Reply to this email directly or view it on GitHub:
https://github.com/rpm-software-management/rpm/pull/4154#issuecomment-4081332365
You are receiving this because you are subscribed to this thread.
Message ID: <rpm-software-management/rpm/pull/4154/c4081332365 at github.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rpm.org/pipermail/rpm-maint/attachments/20260318/4f23a25c/attachment.htm>
More information about the Rpm-maint
mailing list