impactCn opened a new pull request, #7050: URL: https://github.com/apache/shenyu/pull/7050
This pull request adds a comprehensive development guide for contributors working on the Apache ShenYu project. The new documentation covers project context, module structure, coding standards, configuration and dependency management, testing practices, and principles for making changes. It aims to ensure consistency, maintainability, and high-quality contributions across the codebase. Key additions in the documentation: **Project Structure and Contribution Guidelines** - Provides an overview of the main modules (such as `shenyu-web`, `shenyu-plugin`, `shenyu-admin`, etc.), their responsibilities, and best practices for extending or modifying them. Emphasizes preserving backward compatibility and following established extension patterns. **Java Coding Standards** - Details conventions for code style, error handling, logging, naming, and immutability. Stresses the importance of avoiding blocking calls in reactive chains and following the project's logging and exception handling patterns. **Configuration and Dependency Management** - Outlines correct approaches for introducing new configuration properties and managing dependencies, including the use of `dependencyManagement` and avoiding redundant or arbitrary dependencies. **Testing Practices** - Specifies requirements for adding or updating tests, preferred testing libraries, test placement, and coverage expectations, including regression testing for bug fixes. **Change Management Principles** - Advises on keeping pull requests focused, avoiding unrelated changes, and ensuring that -- 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]
