Repository navigation
Conversation
- Replace CLAUDE.md with AGENTS.md: a pointer to CONTRIBUTING.md plus the agent traps it doesn't cover. Project layout, conventions and CI/publish details that were only in CLAUDE.md move to CONTRIBUTING.md. - Add SECURITY.md: GitHub private vulnerability reporting, with security@glassnode.com as fallback. - .gitignore: ignore .env.*, *.local, *.pem and *.key (keeps .env.example). - Drop an internal ticket reference from the publish.yml comment and point the ci.yml comment at CONTRIBUTING.md.
rafalbromirski
approved these changes
Oct 13, 2026
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stacked on #35; merge #35 first. This PR targets
gn-240-version-check-scope, so the diff shows only the GN-180 commit. When #35 merges and its branch is deleted, GitHub retargets this PR tomain.What changed
CLAUDE.md→AGENTS.md.AGENTS.mdis now a short pointer toCONTRIBUTING.mdplus the agent traps it doesn't cover: don't hand-edit the generatedsrc/lib/x402-catalog.ts; don't hit the live API or spend x402 USDC unless asked;scripts/release-*are shared with glassnode-api-ts-client; keep actions pinned by SHA.CONTRIBUTING.mdtakes the parts ofCLAUDE.mdhumans also need that weren't there yet: detailed project layout (hooks,src/libfiles, startup cache), coding conventions, the API query-parameter mapping, a new "CI and workflows (for maintainers)" section (required checkstest (22)/test (24), how to bump a pinned action, the npm Trusted Publisher config, shared release scripts), and the cooldown exemption forglassnode-api/ink-uplot. Duplicated content (versioning, local commands, publish flow) was dropped. The Security section points toSECURITY.md.SECURITY.md(new): report privately via GitHub private vulnerability reporting, or security@glassnode.com as fallback. No bug bounty..gitignore: adds.env.*,*.local,*.pem,*.key, with!.env.exampleso the example config stays tracked.publish.ymlno longer mentions the internal ticket for the repo transfer;ci.ymlpoints toCONTRIBUTING.mdinstead ofCLAUDE.md.NO_RELEASE_PATHSinscripts/check-changelog-heading.mjskeeps bothAGENTSandCLAUDE(this PR deletesCLAUDE.md, so the deletion must still count as docs-only).Not in this PR: a lint step in CI.
pnpm run lintrunseslint ., but eslint isn't a dependency and there is no eslint config, so the script fails witheslint: command not found. Setting up lint is a separate change.NOTICEis unchanged.Verification
BASE_SHA=<main> node scripts/check-changelog-heading.mjs main: passes, no version bump needed (docs/CI-only).pnpm install --frozen-lockfile,pnpm test(113 tests pass),pnpm run build, andnode dist/cli.jswithout credentials exits with "no Glassnode credentials".git check-ignore:.env.exampleis still tracked;.env.localand*.pemare ignored.Downstream impact
None for users of the npm package. Nothing is published: no version bump, no package files changed. Agents and contributors read
AGENTS.md/CONTRIBUTING.mdinstead ofCLAUDE.md.