Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (42 loc) · 3.54 KB

CONTRIBUTING.md

File metadata and controls

71 lines (42 loc) · 3.54 KB
Raw

Contribution Guidelines

Thank you for considering a contribution to this repository. We welcome new examples, fixes, and improvements from the community. For coding guidelines, see the Quicknode Solana coding skill.

See CHANGELOG.md for release history. This file had no changelog before June 2026.

How to Contribute

  • Code: Add new examples or improve existing ones (bug fixes, optimizations, additional features).
  • Bug reports, ideas, feedback: Open an issue describing what you found or what you'd like to see.

Project structure

  • Each example lives at category/example-name/<framework>/, e.g. basics/counter/anchor/.
  • Supported frameworks: anchor, quasar, pinocchio, native, asm. Use the existing layout as a reference.
  • Anchor and Quasar programs usually keep Rust tests under programs/<name>/tests/.
  • Native and Pinocchio tests are Rust + LiteSVM, kept under program/tests/.

Tooling

  • Package manager: pnpm. Commit pnpm-lock.yaml. Do not use yarn or npm here. pnpm is used for repo-wide tooling (formatting, linting, git hooks) and for examples with JavaScript clients, not for running an example's tests.
  • Formatter / linter: Biome. Run pnpm fix from the repo root before submitting a PR.

Testing

Run an example's tests with the command for its framework, from the framework directory (e.g. basics/counter/anchor/):

  • Anchor: anchor test (runs cargo test, per the [scripts] table in Anchor.toml).
  • Quasar: quasar test.
  • Native / Pinocchio: cargo test --manifest-path=./program/Cargo.toml (build first with cargo build-sbf --manifest-path=./program/Cargo.toml).

For an existing test pattern to follow, see basics/counter/anchor/programs/counter_anchor/tests/test_counter.rs.

Native and Pinocchio

  • Use LiteSVM for tests. Native, Pinocchio, and ASM examples are tested exclusively with Rust + LiteSVM; the old @solana/web3.js v1 / solana-bankrun / ts-mocha TypeScript suites were removed (see CHANGELOG.md).
  • The only remaining @solana/web3.js v1 usage is in a couple of wallet-adapter frontend demo apps under tokens/token-extensions/.

ASM

ASM examples keep LiteSVM tests inline in src/lib.rs. Build with sbpf build, test with cargo test.

TypeScript client tests (legacy / optional)

A few paths still use TypeScript with node:test and Codama-generated clients. That is not the default for new Anchor examples. Run with:

npx tsx --test --test-reporter=spec tests/*.ts

Documentation

Every anchor/ (and other framework) directory should include a README.md. Use docs/example-readme-template.md as the starting point.

Also update CHANGELOG.md when you ship user-visible changes.

Style

Write American English in prose (e.g. "behavior", "initialize", "favor"). Code identifiers stay as-is.

  • One H1 per markdown file.
  • Fenced code blocks include a language tag (```rust, ```typescript, ```bash, ```toml).
  • Link canonical Solana terms to the terminology page on first mention in READMEs.

Excluding an example from CI

Add the project path to .github/.ghaignore with a one-line comment explaining why (build failure, needs mainnet fixtures, etc.). Remove entries when the example is fixed.

Code of conduct

Be respectful and inclusive. Constructive feedback only. Report any conduct issues to the maintainers.