Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
89 lines (63 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

89 lines (63 loc) · 2.39 KB

Contributing

Setup

git clone https://github.com/Narcooo/inkos.git
cd inkos
pnpm install
pnpm build
pnpm test

Node ≥ 20, pnpm ≥ 9.

Project Structure

packages/
  core/    # Agents, pipeline, state management, LLM providers
  cli/     # Commander.js commands (22 commands)

Monorepo managed with pnpm workspaces. cli depends on core via workspace:*.

Development

pnpm dev          # Watch mode (both packages)
pnpm build        # Build once
pnpm test         # Run all tests
pnpm typecheck    # Type-check without emitting

Commit Convention

<type>: <description>

Types: feat, fix, refactor, docs, test, chore, perf, ci

Keep commits atomic — one logical change per commit. Split new files, interface changes, tests, and docs into separate commits when they're non-trivial.

Pull Request Checklist

  • pnpm build passes
  • pnpm test passes (all existing + new tests)
  • pnpm typecheck passes
  • New features have tests
  • No unrelated formatting changes (keep diffs focused)
  • Commit messages follow the convention above

Code Style

  • TypeScript, strict mode
  • 2-space indentation
  • Immutable patterns: { ...obj, key: value } over mutation
  • Functions < 50 lines, files < 800 lines
  • Errors must surface, not be swallowed (catch { } without re-throw needs a comment)
  • workspace:* stays in source package.json — the CI pipeline handles version replacement at publish time

Adding a CLI Command

  1. Create packages/cli/src/commands/<name>.ts
  2. Export a Command instance
  3. Register it in packages/cli/src/index.ts
  4. Add --json output support
  5. Support book-id auto-detection when only one book exists

Adding a Genre

  1. Create packages/core/genres/<id>.md with YAML frontmatter
  2. Define: chapterTypes, fatigueWords, numericalSystem, powerScaling, pacingRule, satisfactionTypes, auditDimensions, language
  3. Add genre body (prohibitions, language rules, narrative guidance)

Testing

Tests live next to source in __tests__/ directories. We use Vitest.

pnpm --filter @actalk/inkos-core test    # Core tests only
pnpm --filter @actalk/inkos test         # CLI tests only

For features touching the LLM pipeline, mock the LLM calls — don't make real API requests in tests.

Questions?

Open an issue or check existing ones: https://github.com/Narcooo/inkos/issues