@xkova/sdk 0.1.0-alpha.3 → 0.1.0-alpha.4

package/README.md

@@ -6,7 +6,7 @@ holders, wallets, payments, tokenization, and other customer resources.
 ## Install
 
 ```bash
-npm install @xkova/sdk@0.1.0-alpha.2
+npm install @xkova/sdk@alpha
 ```
 
 Requires Node.js 22 or newer. Keep this package and your API keys on the server.
@@ -491,11 +491,39 @@ idempotency, and settlement. It links the public customer OpenAPI and expanded
 documentation. Installed declarations determine the methods available in your
 version; live documentation may describe a newer release.
 
-## Contributing
+## Writing checks for contributors
 
-Run `pnpm check` from the source repository root before committing. The
-[contributor guide](https://github.com/XKOVA/typescript-sdk/blob/main/CONTRIBUTING.md)
-covers generated files, local pre-push checks, writing rules, and packaging.
+Use plain verbs, concrete examples, and comments that explain non-obvious
+decisions. Vary section length, remove repeated conclusions, and write each
+guide for its reader. Test failure and recovery cases alongside successful
+calls. Keep commits small and omit attribution or co-author trailers.
+
+The local pre-push hook checks both public SDKs before the existing test gates.
+It reads each pushed branch or tag's committed files, plus new commit messages
+that touch either package. Uncommitted edits cannot change that result. No
+build or network access is needed. Use the repository's pinned Node version,
+then install workspace dependencies with `pnpm install` to set up the hook.
+
+To check edits before committing:
+
+```sh
+pnpm --filter @xkova/sdk writing:check
+```
+
+The check covers package guides, examples, public source and generated types,
+and descriptive package metadata. It rejects stock wording, emoji, em dashes,
+attribution, internal decision narratives, and implementation-provider details.
+Describe installation, supported methods, inputs, results, and the steps an
+application developer needs. Do not turn release planning or maintainer
+conversations into package documentation. Standard license text, rule
+definitions, and negative test fixtures are checked separately.
+
+A pass is a mechanical check, not a judgment of authorship. Before pushing,
+reread the result for sentence rhythm, repeated structures, useful comments,
+accurate examples, and test quality. This gate does not scan historical file
+contents or replace secret scanning. It checks commit messages locally;
+review PR descriptions separately. Run `pnpm --filter @xkova/sdk writing:test`
+when changing the rules or hook.
 
 ## License