Pulsar java contrib is to provide a non-core code maintenance repository to collect plugin implementations, personalized features, experimental features, and best practices from users.
-
Plugin Contribution Guide lists the core interfaces in Pulsar that can be implemented by contributors, and provides implementation guidelines for each type of interface.
-
Plugin Implementation List lists the implemented plugins. Users can select the ones they need for reuse.
-
Personalization Features lists the customized features and experimental features that require modification to the Pulsar source code.
-
Best Practices lists the best practices for each function summarized by community contributions.
This project follows the terms of Apache License 2.0.
You can format the code by mvn spotless:apply and generate license headers by mvn license:format.
Please note that the code formatted by Spotless may still not meet the formatting requirements. Please run mvn checkstyle:check for inspection.
pulsar-java-contrib is actively in development. If you have some common use cases for plugins, please contact us and we'll be happy to support. Please open an issue to share your idea or suggestion. PRs are always welcome and greatly appreciated, but for larger functional changes a pre-coding introduction can be helpful to ensure this is the correct place and that active or conflicting efforts don't exist.
Compared with pulsar , pulsar-java-contrib is faster, and there is no need to send emails for DISCUSSION and VOTE. it can be summarized as follows:
- for simple changes, you only need to submit a PR for code changes
- for larger improvement proposal, you need to submit a PR for code changes + a design document (the file is placed in pcip/pcip-xxx.md) For detailed development process description, see: pcip/README.md