spring-projects / spring-projects/spring-integration-samples

Project Structure - Reorganize in favor of JavaDSL and Reactive support

Open
#319 12 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
2.4k
Forks
2.5k
PR merge metrics
No merged PRs in 30d

Description

Currently, this project looks like a project that has lots of examples. Underlying these examples are mostly XML-based, which is super unreadable for new users. I think this project should be reorganized and instead of dirs like intermediate, applications, advanced, basic, dsl, there's should be:

  • xml
    • basic
    • intermediate
    • advanced
  • java
    • reactive
      • basic
      • intermediate
      • advanced
    • non-reactive
      • basic
      • intermediate
      • advanced
  • specific-applications
    • xml
    • java
      • reactive
      • non-reactive

Notice that if a sample is JavaDSL based, it is super unreadable to use inside of its parts of another XML-based POJOs.

Another horrible thing is that there are samples whose names are not based on the libraries, but some random names like "Loanshark". The purpose of samples is to make it clear how the usage looks. The application purpose is irrelevant and confusing.

I don't know what is applications place in the world. I'm also not sure if basic, intermediate, and advanced separation is needed. People would be fine if there would all sit together.

This really doesn't require a lot of work and can be super helpful to people. Even if you open an empty folder for reactive, or very thin folders for java in general, it would let people comfortably contribute.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inventorying the existing intermediate, applications, advanced, basic, and dsl directories and the samples named in the issue. Review the proposed xml, java, reactive, non-reactive, and specific-applications layout, then resolve whether the basic/intermediate/advanced split remains. Done means the sample structure is reorganized consistently and the naming clearly reflects Java DSL, XML, and reactive support.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
developer-experience
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.