Development

Guide for contributing to and building SpringFlow.

In this section

• Contributing

  ---

  Contribution guide for the project

• Building

  ---

  Compiling and building the project

• Testing

  ---

  Testing strategy and running the test suite

• Release Process

  ---

  How versions are published

Developer Quick Start

1. Clone the repository

git clone https://github.com/tky0065/springflow.git
cd springflow

2. Build

./mvnw clean install

3. Run tests

./mvnw test

4. Run the demo

cd springflow-demo
../mvnw spring-boot:run

Project Structure

springflow/
├── springflow-annotations/   # Annotations (zero dependencies)
├── springflow-core/          # Core implementation
├── springflow-graphql/       # Optional GraphQL module
├── springflow-starter/       # Spring Boot auto-configuration
└── springflow-demo/          # Demo application

How to Contribute

1. Fork the repository
2. Create a branch (git checkout -b feature/my-feature)
3. Commit your changes (git commit -m 'feat: add my feature')
4. Push to your branch (git push origin feature/my-feature)
5. Open a Pull Request

See the Contributing Guide for full details.

Pre-PR Checklist

• [ ] Code compiles without errors
• [ ] All tests pass (./mvnw test)
• [ ] Coverage > 80% for new code
• [ ] Javadoc added for public APIs
• [ ] CHANGELOG.md updated
• [ ] Commit messages follow conventional commits

Recommended Tools

• IDE: IntelliJ IDEA / Eclipse / VS Code
• Java: JDK 17 or higher
• Build: Maven 3.6+

Developer Documentation

• CONTRIBUTING.md — full contribution guide
• Architecture — architectural decisions

---

Questions? Open a discussion or an issue.