Contribution Process

Reporting bugs and requesting features

File a GitHub Issue.

Use the issue templates — they collect the version, platform, and reproduction steps needed to act on the report quickly.

Contributing code

Fork the repo and submit a pull request from your fork. All forks of snowflake-cli are publicly visible on GitHub.

Keep your fork up to date by rebasing onto upstream rather than merging:

git remote add sfcli https://github.com/snowflakedb/snowflake-cli.git
git fetch sfcli
git checkout <your-branch>
git rebase sfcli/main

A maintainer will review and merge your PR after approval using squash and merge. If your PR is approved and all checks pass but you cannot merge, comment directly on your PR or contact a maintainer via GitHub Issues.

Commit message format

The squash commit title becomes the permanent commit message on main. Follow Conventional Commits and include the ticket number:

feat: [SNOW-1234567] add support for X
fix: [SNOW-1234567] correct Y when Z is empty
chore: [SNOW-1234567] bump dependency versions

Common types: feat, fix, chore, docs, refactor, test.

PR etiquette

Open your PR as a draft while work is still in progress. Move it to ready for review only when you consider the work complete and all automated CI checks have passed. Do not move a PR to ready while CI is red.

Fill in the PR checklist honestly — reviewers check every item.

PR checklist

The two items contributors most commonly miss:

Design sign-off — any user-facing interface change (new commands, arguments, options, or output format) requires maintainer sign-off before code is written. See adding-commands.md.

Snapshot files — any change to CLI output or help text, including hidden commands, requires regenerating snapshots. See testing.md.

Release notes — see lifecycle.md for what requires an entry and the exact format. CI will fail if RELEASE-NOTES.md is not modified; add the skip-release-notes label to the PR if no entry is warranted (e.g. pure test or doc changes). Wrong section or wrong scope will be caught in review.