Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
20
2 changes: 2 additions & 0 deletions .tool-versions
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
nodejs 20.18.0
pnpm 10.33.0
36 changes: 36 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,42 @@ We believe that a welcoming and inclusive environment fosters collaboration and

To ensure a smooth and effective contribution process, please take a moment to review and follow the guidelines outlined below.


## Environment Setup

To run the examples in this repository consistently across machines, use the version files at the repo root:

| File | Purpose | Tool |
|------|---------|------|
| `.nvmrc` | Node.js version (20) | nvm / fnm / volta |
| `.tool-versions` | Node.js + pnpm versions | asdf |

**Quick setup:**

```bash
# Using nvm (Node Version Manager)
nvm install # reads .nvmrc
nvm use

# Or using fnm
fnm install
fnm use

# Or using asdf
asdf install

# Install pnpm (required version pinned in package.json)
corepack enable
corepack prepare pnpm@10.33.0 --activate
pnpm install
```

**Why these versions?**

- **Node 20** — matches `@types/node: ^20.9.0` devDependency and avoids Node 23 issues reported in #579
- **pnpm 10.33.0** — pinned via `packageManager` field in root `package.json`; consistent installs across machines

**Solana / Anchor versions** vary per example. Check each example's `Cargo.toml` for the exact `anchor-lang` version required. Common versions in this repo: Anchor 0.30+, Solana 1.18+.
## How to Contribute

We welcome contributions in the form of code, documentation, bug reports, feature requests, and other forms of feedback. Here are some ways you can contribute:
Expand Down