https://github.com/apache/pulsar-java-contrib
Contributor repository for code samples, plugins and libraries in Java for Apache Pulsar
https://github.com/apache/pulsar-java-contrib
apache-pulsar java pulsar
Last synced: 5 months ago
JSON representation
Contributor repository for code samples, plugins and libraries in Java for Apache Pulsar
- Host: GitHub
- URL: https://github.com/apache/pulsar-java-contrib
- Owner: apache
- License: apache-2.0
- Created: 2024-08-20T12:26:05.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-12-17T15:20:26.000Z (7 months ago)
- Last Synced: 2025-01-30T10:23:51.509Z (5 months ago)
- Topics: apache-pulsar, java, pulsar
- Language: Java
- Homepage: https://pulsar.apache.org/
- Size: 1.19 MB
- Stars: 12
- Watchers: 34
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Apache Pulsar Java Contrib
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](contributionGuides.md) lists the core interfaces in Pulsar that can be implemented by contributors, and provides implementation guidelines for each type of interface.
- [Plugin Implementation List](contributedFeatures.md) lists the implemented plugins. Users can select the ones they need for reuse.
- [Personalization Features](customizationFeatures.md) lists the customized features and experimental features that require modification to the Pulsar source code.
- [Best Practices](best-practice-blogs) lists the best practices for each function summarized by community contributions.
- [consume-best-practice.md](best-practice-blogs%2Fconsume-best-practice.md)
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.
## Contributing
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](https://github.com/apache/pulsar-java-contrib/issues/new) 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.
## Development Process
Compared with [pulsar](https://github.com/apache/pulsar) , [pulsar-java-contrib](https://github.com/apache/pulsar-java-contrib) is faster, and there is no need to send emails for DISCUSSION and VOTE.
it can be summarized as follows:
1. for simple changes, you only need to submit a PR for code changes
2. 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