|
| 1 | +## Project Overview |
| 2 | + |
| 3 | +For detailed project information, setup instructions, and API documentation, see: |
| 4 | + |
| 5 | +@import README.md |
| 6 | + |
| 7 | +## User-Specific Preferences |
| 8 | + |
| 9 | +@import ~/.claude/truelayer-java.md |
| 10 | + |
| 11 | +## Build & Test Commands |
| 12 | + |
| 13 | +Use `just` for all development tasks: |
| 14 | + |
| 15 | +- `just build` - Build the project |
| 16 | +- `just format` - Apply code formatting |
| 17 | +- `just unit-test` - Run unit tests |
| 18 | +- `just integration-test` - Run integration tests |
| 19 | +- `just test` - Run all tests |
| 20 | + |
| 21 | +Run `just -l` to see all available commands. |
| 22 | + |
| 23 | + |
| 24 | +## Testing |
| 25 | +- Unit tests in `src/test/java/com/truelayer/java/` |
| 26 | +- Integration tests require mock responses in `src/test/resources/__files/` |
| 27 | +- Acceptance tests require environment variables (see README) |
| 28 | + |
| 29 | +## Pull Request Guidelines |
| 30 | + |
| 31 | +When creating a PR, Claude will ask for a JIRA ticket reference if: |
| 32 | +- The GitHub user is part of the Api Client Libraries team at TrueLayer |
| 33 | +- The GitHub username has a `tl-` prefix |
| 34 | +- When in doubt, an optional ACL ticket reference will be requested |
| 35 | + |
| 36 | +Format: `[ACL-XXX]` in the PR title for JIRA ticket references. |
| 37 | + |
| 38 | +### CI Optimization |
| 39 | +When making changes that don't affect the Java artifact (CODEOWNERS, CI workflows, documentation, etc.), consider adding `[skip ci]` to the squash merge commit message to avoid unnecessary CI runs, following GitHub's best practices. |
| 40 | + |
| 41 | + |
| 42 | +## Development Tips |
| 43 | +- Check existing similar functionality before implementing new features |
| 44 | +- Follow existing naming conventions |
| 45 | +- Add unit tests for new functionality |
| 46 | +- Use mock JSON responses for integration tests |
| 47 | +- If you are adding fields to the requests or responses, verify that the response test data included in the integration tests is updated accordingly |
| 48 | +- When running acceptance tests, check the README.md how to run acceptance tests and warn me if requirements are not met |
| 49 | + |
| 50 | +## Release Guidelines |
| 51 | + |
| 52 | +When making changes to Java code: |
| 53 | + |
| 54 | +1. **Version Updates**: Always update the version value in `gradle.properties`. When opening a PR or making it ready, suggest the user give you permissions to amend the version if needed. |
| 55 | + |
| 56 | +2. **Semantic Versioning**: Follow semantic versioning principles. Any change that breaks the build on projects referencing this library is considered a breaking change. |
| 57 | + |
| 58 | +3. **Backward Compatibility**: Strive to adopt backward compatible changes whenever possible. When backward compatibility cannot be maintained, create a new major version. |
0 commit comments