sujaykarmakar opened a new pull request, #1037:
URL: https://github.com/apache/tomcat/pull/1037

   ## Summary
   
   This PR adds package-level `README.md` files for the following core Tomcat 
packages:
   
   * `java/org/apache/catalina/README.md`
   * `java/org/apache/coyote/README.md`
   * `java/org/apache/tomcat/util/README.md`
   
   ## What’s included
   
   Each README provides a high-level overview of the package, including:
   
   * The package's purpose and responsibilities
   * Major components and commonly used classes/interfaces
   * How the package fits into Tomcat's overall architecture
   * Relationships with other core packages
   
   ## Motivation
   
   While Tomcat has comprehensive Javadocs and architecture documentation, it 
can take some time for new contributors to understand the role of each package 
when navigating the source tree. These READMEs are intended to serve as quick 
entry points and improve codebase discoverability without duplicating existing 
documentation.
   
   ## Impact
   
   * Documentation-only change
   * No code, API, or behavioral changes
   * No impact on build, tests, or runtime
   


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


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to