The project connector-kafka-consumer is a Bonita Connector for Bonita 10.0 Community version written in java language.
TODO: A brief description of your project, what it is used for and how does life get awesome when someone starts to use it.
TODO: What’s all the bells and whistles this project can perform?
-
What’s the main functionality
-
You can also do another thing
-
If you get really handy, you can even do this
TODO: A quick introduction of the minimal setup you need to get a hello world up & running. For more details on Bonita Connector please refer to documentation
TODO: Here’s a brief introduction about what a developer must do in order to start developing the project further:
Prerequisite:
-
Java ( jdk 17 or higher)
-
Maven (optional if you choosed to use maven wrapper script as archetype option)
-
A Git client (optional but highly recommended)
TODO: If your project needs some additional steps for the developer to build the project after some code changes, state them here:
git clone https://your.github.com/connector-kafka-consumer.git
cd connector-kafka-consumer/
./mwnw packageThe build should produce a jar archive under the target/ folder named connector-kafka-consumer-1.0-SNAPSHOT.jar
TODO: Here again you should state what actually happens when the code above gets executed.
For more details about Apache Maven, please refer to the documentation
TODO: In case there’s some step you have to take that publishes this project to a server, this is the right time to state it.
TODO: Make easy to your team to jump in and start contributing to your project.
These paragraphs are meant to welcome those kind souls to feel that they are needed. You should state something like:
"If you’d like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome."
If there’s anything else the developer needs to know (e.g. the code style
guide), you should link it here. If there’s a lot of things to take into
consideration, it is common to separate this section to its own file called
CONTRIBUTING.adoc (or similar). If so, you should say that it exists here.
TODO: Even though this information can be found inside the project on machine-readable format like in a .json file, it’s good to include a summary of most useful links to humans using your project. You can include links like:
-
Project homepage: https://github.com/bonitasoft-presales/connector-kafka
-
Repository: https://github.com/bonitasoft-presales/connector-kafka
-
Issue tracker: https://github.com/bonitasoft-presales/connector-kafka/issues