mirror of
https://github.com/xerial/snappy-java.git
synced 2025-07-22 13:34:27 +02:00
Update CLAUDE.md development workflow
- Fix typo in 'commit' - Add PR guidelines and common development tasks - Update native code build command to use 'make clean-native native'
This commit is contained in:
parent
066b9af9c2
commit
b8cb2bf1a9
17
CLAUDE.md
17
CLAUDE.md
@ -98,4 +98,19 @@ The project uses Docker-based cross-compilation toolchains (see `docker/` direct
|
||||
2. **Memory Safety**: Uses direct ByteBuffers for efficient memory operations - be aware of buffer boundaries
|
||||
3. **Thread Safety**: Snappy compression/decompression methods are thread-safe as they don't maintain state
|
||||
4. **OSGi Support**: The project includes OSGi bundle configuration in build.sbt
|
||||
5. **Compatibility**: Multiple stream formats are supported - ensure you use matching read/write formats (see compatibility matrix in README.md)
|
||||
5. **Compatibility**: Multiple stream formats are supported - ensure you use matching read/write formats (see compatibility matrix in README.md)
|
||||
|
||||
## Development Workflow
|
||||
|
||||
### Pull Request Guidelines
|
||||
- Use squashed commits when merging PRs to maintain clean commit history
|
||||
- Run tests before creating PR: `./sbt test`
|
||||
- Check code formatting: `./sbt scalafmtCheckAll`
|
||||
|
||||
### Common Development Tasks
|
||||
- When making changes to native code, rebuild with `make clean-native native`
|
||||
- For Java/Scala changes, use `./sbt ~test` for continuous testing
|
||||
- Always test on multiple JDK versions if possible (8, 11, 17, 21)
|
||||
|
||||
### Native Code Testing
|
||||
- Use make clean-native native for testing native code
|
Loading…
x
Reference in New Issue
Block a user