diff --git a/.github/workflows/publish-npm.yml b/.github/workflows/publish-npm.yml index 148e1a3..55f1f7d 100644 --- a/.github/workflows/publish-npm.yml +++ b/.github/workflows/publish-npm.yml @@ -99,6 +99,9 @@ jobs: files: [binFile], description: pkg.description, license: pkg.license, + repository: pkg.repository, + homepage: pkg.homepage, + bugs: pkg.bugs, os: [t.os], cpu: [t.cpu], }; diff --git a/CLAUDE.md b/CLAUDE.md index b609312..781bb81 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -2,6 +2,15 @@ This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. +## Public repository + +This repo is **public**. Code, comments, commit messages, and PR descriptions are world-readable. Do not include internal-only details — only reference what is already public via the external REST APIs and the SDK's own public surface. + +- **OK to mention**: public REST endpoints, request/response shapes documented at quicknode.com/docs, the SDK's own exported types/methods, public package names (`@quicknode/sdk`, `quicknode-sdk`, `quicknode_sdk`). +- **Do not mention**: internal service names, internal infra/hostnames, private repos or paths, Linear/Jira ticket IDs, Slack channels, employee names, internal incident details, internal API quirks not reflected in the public docs, or "why we chose X" reasoning that exposes internal strategy. +- If a fix is driven by internal context (incident, ticket, private discussion), describe the **observable behavior** that's being fixed — not the internal trigger. The commit message and PR description should read as if written by an external contributor. +- When in doubt, ask before publishing. + ## Build & Development Commands ### Rust diff --git a/crates/core/Cargo.toml b/crates/core/Cargo.toml index 46bc2dc..5b42b70 100644 --- a/crates/core/Cargo.toml +++ b/crates/core/Cargo.toml @@ -4,7 +4,7 @@ version = "0.1.0-alpha.29" edition.workspace = true license.workspace = true description = "Core library for quicknode sdk" -repository = "https://github.com/quiknode-labs/sdk" +repository = "https://github.com/quicknode/sdk" readme = "README.md" keywords = ["quicknode", "blockchain", "web3", "sdk"] categories = ["api-bindings", "web-programming"] diff --git a/crates/core/README.md b/crates/core/README.md index 5a5cb56..8b73d87 100644 --- a/crates/core/README.md +++ b/crates/core/README.md @@ -2,7 +2,7 @@ The core Rust crate for the Quicknode SDK. -This is one of four language bindings published from the same Rust core. See the [project README](https://github.com/quiknode-labs/sdk/blob/main/README.md) for the polyglot overview, development setup, and release process. +This is one of four language bindings published from the same Rust core. See the [project README](https://github.com/quicknode/sdk/blob/main/README.md) for the polyglot overview, development setup, and release process. ## Table of Contents diff --git a/npm/README.md b/npm/README.md index fb92f5c..7e2daa6 100644 --- a/npm/README.md +++ b/npm/README.md @@ -2,7 +2,7 @@ Node.js / TypeScript bindings for the Quicknode SDK. -This is one of four language bindings published from the same Rust core. See the [project README](https://github.com/quiknode-labs/sdk/blob/main/README.md) for the polyglot overview, development setup, and release process. +This is one of four language bindings published from the same Rust core. See the [project README](https://github.com/quicknode/sdk/blob/main/README.md) for the polyglot overview, development setup, and release process. ## Table of Contents diff --git a/npm/package.json b/npm/package.json index 4315a16..293e1cb 100644 --- a/npm/package.json +++ b/npm/package.json @@ -2,6 +2,14 @@ "name": "@quicknode/sdk", "version": "3.1.0-alpha.29", "description": "Quicknode SDK", + "repository": { + "type": "git", + "url": "git+https://github.com/quicknode/sdk.git" + }, + "homepage": "https://github.com/quicknode/sdk", + "bugs": { + "url": "https://github.com/quicknode/sdk/issues" + }, "main": "sdk.js", "types": "sdk.d.ts", "exports": { diff --git a/pyproject.toml b/pyproject.toml index d53575b..0627623 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -25,9 +25,9 @@ classifiers = [ ] [project.urls] -Homepage = "https://github.com/quiknode-labs/sdk" -Repository = "https://github.com/quiknode-labs/sdk" -Issues = "https://github.com/quiknode-labs/sdk/issues" +Homepage = "https://github.com/quicknode/sdk" +Repository = "https://github.com/quicknode/sdk" +Issues = "https://github.com/quicknode/sdk/issues" [tool.maturin] manifest-path = "crates/python/Cargo.toml" diff --git a/python/README.md b/python/README.md index ef92d28..e800132 100644 --- a/python/README.md +++ b/python/README.md @@ -2,7 +2,7 @@ Python bindings for the Quicknode SDK. -This is one of four language bindings published from the same Rust core. See the [project README](https://github.com/quiknode-labs/sdk/blob/main/README.md) for the polyglot overview, development setup, and release process. +This is one of four language bindings published from the same Rust core. See the [project README](https://github.com/quicknode/sdk/blob/main/README.md) for the polyglot overview, development setup, and release process. ## Table of Contents diff --git a/ruby/README.md b/ruby/README.md index 92f235c..d12f348 100644 --- a/ruby/README.md +++ b/ruby/README.md @@ -2,7 +2,7 @@ Ruby bindings for the Quicknode SDK. -This is one of four language bindings published from the same Rust core. See the [project README](https://github.com/quiknode-labs/sdk/blob/main/README.md) for the polyglot overview, development setup, and release process. +This is one of four language bindings published from the same Rust core. See the [project README](https://github.com/quicknode/sdk/blob/main/README.md) for the polyglot overview, development setup, and release process. ## Table of Contents