raboof commented on PR #7930: URL: https://github.com/apache/geode/pull/7930#issuecomment-3341570273
> @wmh1108-sas , I respectfully disagree with the characterization of this as clutter. The rationale for including detailed context is to streamline the review process and reduce dependency on follow-up communication. This approach is aligned with best practices in documentation and change management. While it may seem extensive, it serves a strategic purpose in ensuring clarity and accountability. Including context can indeed help the review process. This can be achieved by putting the context in the PR (commit message, PR description, review comments). Keeping such context in the code is distracting: future readers should not be bothered with information about how the code 'used to be', only how it 'is right no'. If they need to find out what the code looked like earlier, which should be rare, can be done by looking at the history and PR. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
