joerghoh commented on PR #20: URL: https://github.com/apache/sling-org-apache-sling-discovery-oak/pull/20#issuecomment-5031793405
some general remarks regarding the inline comments: * remove any reference to the actual SLING ticket, unless the code is absolutely counter-intuitive and requires the additional context of the SLING ticket. * keep the comments brief. Do not over-explain potential root-causes or how a situation evolves, all of that belongs in the Jira ticket and/or the PR documentation. * in general: Imagine that in 12 months you need to adjust this code/class again. Then you are NOT interested in verbose comments which just clutter the code, especially if the aspect you need to change/augment is a different one. -- 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]
