dimas-b commented on code in PR #4368:
URL: https://github.com/apache/polaris/pull/4368#discussion_r3197667482


##########
CONTRIBUTING.md:
##########
@@ -54,6 +54,10 @@ When creating your feature request, document your 
requirements first. Please, tr
 
 ## Before you begin contributing code 
 
+### Get oriented in the codebase
+
+Before diving into a change, it helps to know where things live. The [Code 
Wiki for Apache Polaris](https://codewiki.google/github.com/apache/polaris) is 
a third-party, auto-generated overview of modules and their relationships, 
useful for fast orientation. It is a navigation aid, not authoritative, so 
verify details against the source tree before relying on them for design 
decisions.

Review Comment:
   TBH, this CodeWiki is a lot of text... I glanced over it, but it's mostly 
TL;DR from my side 😅 
   
   Still, if people find it useful, why not link?
   
   The preamble here looks correct to me.



-- 
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]

Reply via email to