bd002e4aaf
Add 'eclipse' folder containing Eclipse code formatter configuration and instructions how to use it. Update rule for join_wrapped_lines - Set to `false` Resolves #930 Update README Address review comments
56 lines
4.1 KiB
Plaintext
56 lines
4.1 KiB
Plaintext
== Spring Cloud Stream image:https://build.spring.io/plugins/servlet/buildStatusImage/SCS-SMJLE[Build Status, link=https://build.spring.io/browse/SCS-SMJLE] image:https://badge.waffle.io/spring-cloud/spring-cloud-stream.svg?label=ready&title=Ready[Stories Ready, link=http://waffle.io/spring-cloud/spring-cloud-stream] image:https://badge.waffle.io/spring-cloud/spring-cloud-stream.svg?label=In%20Progress&title=In%20Progress[Stores In Progress, link=http://waffle.io/spring-cloud/spring-cloud-stream] image:https://badges.gitter.im/spring-cloud/spring-cloud-stream.svg[link="https://gitter.im/spring-cloud/spring-cloud-stream?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"]
|
|
|
|
This project allows a user to develop and run messaging microservices using Spring Integration and run them locally or in the cloud. Just add `@EnableBinding` and run your app as a Spring Boot app (single application context).
|
|
|
|
Since version 1.1, Spring Cloud Stream follows a decentralized model where the core components and the binder implementations are developed and released separately.
|
|
This repository contains the core components of the project and does not contain any binder implementations.
|
|
|
|
The repository for the Spring Cloud Stream Release Train is here: https://github.com/spring-cloud/spring-cloud-stream-starters
|
|
|
|
Information on the Spring Cloud Stream release train can be found here: https://github.com/spring-cloud/spring-cloud-stream-starters/wiki#release-notes.
|
|
|
|
=== Binder implementations
|
|
|
|
The following binder implementations are currently available:
|
|
|
|
* *Kafka* https://github.com/spring-cloud/spring-cloud-stream-binder-kafka
|
|
* *RabbitMQ* https://github.com/spring-cloud/spring-cloud-stream-binder-rabbit
|
|
|
|
=== Documentation
|
|
|
|
The latest documentation for the project can be found http://docs.spring.io/spring-cloud-stream/docs/current-SNAPSHOT/reference/htmlsingle/[here].
|
|
|
|
=== Samples
|
|
|
|
For Spring Cloud Stream samples, take a look to the https://github.com/spring-cloud/spring-cloud-stream-samples[samples repository].
|
|
|
|
=== Question, Bugs and Enhancements
|
|
|
|
The project team is happy to receive feedback from the community and answer questions.
|
|
|
|
We use Git Hub issues for tracking bugs and feature requests.
|
|
If you would like to report a bug or to suggest a feature, please open a Git Hub issue.
|
|
|
|
Any question that is not a bug or an issue should be asked on Stack Overflow, using the tag http://stackoverflow.com/questions/tagged/spring-cloud-stream[`spring-cloud-stream`].
|
|
|
|
=== Contributing
|
|
|
|
We love contributions. Follow this https://github.com/spring-cloud/spring-cloud-commons#contributing[link] for more information on how to contribute.
|
|
|
|
=== Code formatting guidelines
|
|
|
|
* The directory `eclipse` contains two files that can be used to configure the formatting rules in your IDE: `eclipse-code-formatter.xml` for the majority of the code formatting rules and `eclipse.importorder` to order the import statements.
|
|
|
|
* In Eclipse you import these files by navigating `Windows -> Preferences` and then the menu items `Preferences > Java > Code Style > Formatter` and `Preferences > Java > Code Style > Organize Imports` respectively.
|
|
|
|
* In `IntelliJ`, install the plugin `Eclipse Code Formatter`.
|
|
You can find it by searching the "Browse Repositories" under the plugin option within `IntelliJ` (Once installed you will need to reboot Intellij for it to take effect).
|
|
Then navigate to `Intellij IDEA > Preferences` and select the Eclipse Code Formatter.
|
|
Select the `eclipse-code-formatter.xml` file for the field `Eclipse Java Formatter config file` and the file `eclipse.importorder` for the field `Import order`.
|
|
Enable the `Eclipse code formatter` by clicking `Use the Eclipse code formatter` then click the *OK* button.
|
|
** NOTE: If you configure the `Eclipse Code Formatter` from `File > Other Settings > Default Settings` it will set this policy across all of your Intellij projects.
|
|
|
|
== Code of Conduct
|
|
This project adheres to the Contributor Covenant link:CODE_OF_CONDUCT.adoc[code of conduct]. By participating, you are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
|
|
|