Sitelet https://github.com/openscan-explorer/hardhat-plugin/blob/main/CLAUDE.md
Skip to content

CLAUDE.md

Latest commit

 

History

History
79 lines (60 loc) · 3.58 KB

CLAUDE.md

File metadata and controls

79 lines (60 loc) · 3.58 KB
Raw

@openscan/hardhat-plugin

pnpm workspace. Packages live under packages/.

Git workflow

MatiasOS/hardhat-plugin (origin) is a fork of openscan-explorer/hardhat-plugin (openscan), where most work happens. Its default branch is dev; upstream's is main. Pull requests run cross-fork: MatiasOS:<branch> → base main on openscan-explorer/hardhat-plugin.

One branch per issue. Never commit directly to the default branch — dev here, main in an upstream clone; the hook resolves it per clone. Branch first:

  • issue-<n>-<slug> when there's a tracked issue — issue-42-verify-on-deploy
  • <type>/<slug> when there isn't — ci/add-missing-repo-url, fix/network-name-restriction

Conventional Commits, strictly — type(scope)?: description

  • Lowercase type from: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert
  • Subject ≤72 characters, no trailing period, imperative mood
  • Scopes in use here: explorer, plugin, example-project
  • Exempt: merge, revert, fixup!/squash!, and release subjects (v1.3.0)
feat(explorer): open browser on network page
fix(plugin): prevent multiple logs on startup
chore(example-project): dont track ignition dir for easy testing

Enforcement

These rules are not advisory — .githooks/ enforces them for every contributor, activated by pnpm install via the prepare script. commit-msg checks the subject format and scans for attribution; pre-commit guards the default branch. The rules live in one place, .githooks/lib/git-rules.mjs, covered by pnpm test:hooks.

A rejection is the rule firing, not a flaky failure — fix the message or the branch rather than retrying. For a deliberate exception, ask first, then prefix the command with ALLOW_NONCONVENTIONAL_COMMIT=1, ALLOW_DEFAULT_BRANCH_COMMIT=1 or ALLOW_AI_ATTRIBUTION=1. See CONTRIBUTING.md.

Authorship

Commits and PRs carry no AI attribution — no Co-Authored-By: Claude trailer, no 🤖 Generated with [Claude Code] footer, no "AI-generated" notes in code comments or PR bodies. The human running the session is the sole author; write commit messages in their voice, describing the change rather than what produced it.

Resolving an issue

Issues are tracked in openscan-explorer/explorer: issue-402-trim-build-info resolves explorer#402. Every resolved issue ends with the two steps below, without waiting to be asked. No hook enforces them.

Bump the plugin version whenever the branch changes anything under packages/plugin/. Set version in packages/plugin/package.json one step past upstream main: minor for feat, major for a breaking change, patch for anything else. Commit it last and on its own, with the bare version as the subject (v1.3.2, exempt from the format check). One bump per branch; if main reaches that version first, rebase and bump again. Merging to main publishes to npm, and pnpm publish skips an already-published version without failing, so an unbumped merge ships nothing while CI stays green.

Open a pull request for the issue:

pnpm build && pnpm test && pnpm lint
git push -u origin <branch>
gh pr create --repo openscan-explorer/hardhat-plugin --base main --head MatiasOS:<branch>

Title it like a commit subject. Open the body with Fixes openscan-explorer/explorer#<n>, or Part of when work on the issue remains outside this repo. Leave the merge to a maintainer, since merging publishes.