Skip to content

Add .claude/CLAUDE.md with project conventions #1108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
sfc-gh-ggeng wants to merge 1 commit into
base: master
Choose a base branch
from
+36 −0
Draft

Add .claude/CLAUDE.md with project conventions #1108

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .claude/CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# CLAUDE.md

## Build & Test

- Build: `mvn compile`
- Run all tests: `mvn test`
- Run a single test: `mvn test -Dtest=ClassName`
- Run specific test method: `mvn test -Dtest=ClassName#methodName`

## Required Steps Before Committing

- **Always run `./format.sh`** before committing. This sorts pom.xml and formats all Java sources with google-java-format. Commits with unformatted code will fail CI.

## Code Style

- Java sources are formatted with google-java-format 1.20.0
- Imports are sorted alphabetically (enforced by the formatter)
- pom.xml is sorted by sortpom-maven-plugin

## Project Structure

- `src/main/java/net/snowflake/ingest/` — main source
- `utils/` — shared utilities (ErrorCode, HttpUtil, SFException, etc.)
- `connection/` — HTTP connection and telemetry
- `streaming/internal/` — streaming ingest internals
- `streaming/internal/fileTransferAgent/` — cloud storage upload (S3, Azure, GCS)
- `src/test/java/net/snowflake/ingest/` — tests mirror the main structure

## JDBC Removal Project

When replicating classes from `snowflake-jdbc`:
- Copy verbatim — do not refactor, rename fields, or change logic
- Add a header comment with the source URL: `Source: https://github.com/snowflakedb/snowflake-jdbc/blob/v3.25.1/...`
- Include a Replication Verification Diff Report in the PR description
- Port corresponding unit tests
- For classes from `snowflake-common`, prefer adding a direct dependency over copying