Skip to content

docs: add CONTRIBUTING, issue/PR templates, and .editorconfig - #16

Merged
kjellberg merged 1 commit into
kiqr:mainfrom
kjellbergzoey:docs/contributing-and-templates
Jun 7, 2026
Merged

docs: add CONTRIBUTING, issue/PR templates, and .editorconfig#16
kjellberg merged 1 commit into
kiqr:mainfrom
kjellbergzoey:docs/contributing-and-templates

Conversation

@kjellbergzoey

Copy link
Copy Markdown
Contributor

Summary

Pure additive documentation and tooling — no source changes. These files lower the contributor on-ramp toward the agency-standard goal of a self-service, well-documented repo.

What's included

  • CONTRIBUTING.md — setup (Node 18+, npm install), the dev loop (npm run dev/build/test/typecheck), coding standards, the Biome lint/format flow (referenced as npm run lint/npm run format, landing via chore: adopt Biome for linting and formatting #10), the branch + PR workflow, and the requirement that CI (typecheck/test/build on Node 20/22/24) must pass.
  • .github/ISSUE_TEMPLATE/bug_report.md and feature_request.md — capture kiqr version, OS, Docker version, and repro/expected/actual.
  • .github/PULL_REQUEST_TEMPLATE.md — summary, type of change, how tested, and a checklist including typecheck/test/build.
  • .editorconfig — 2-space indent, LF, UTF-8, trim trailing whitespace, final newline (markdown keeps trailing whitespace for line breaks).

Everything was verified accurate against this repo's package.json, Makefile, and .github/workflows/ci.yml.

How tested

No source changed, but verified the repo is still green:

  • npm run typecheck passes
  • npm test passes (70 tests, 14 files)
  • npm run build passes

Type of change

  • Documentation

🤖 Generated with Claude Code

Add contributor on-ramp files to lower the barrier to contributing:
- CONTRIBUTING.md covering setup, dev loop, coding standards, branch/PR
  workflow, and the Node 20/22/24 CI requirements.
- Bug report and feature request issue templates capturing kiqr version,
  OS, Docker version, and repro/expected/actual details.
- Pull request template with summary, type of change, testing, and a
  typecheck/test/build checklist.
- .editorconfig enforcing 2-space indent, LF, UTF-8, trimmed trailing
  whitespace, and a final newline.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@kjellberg
kjellberg merged commit e25b237 into kiqr:main Jun 7, 2026
3 checks passed
kjellbergzoey added a commit to kjellbergzoey/cli that referenced this pull request Jun 7, 2026
Adds @biomejs/biome with a project config (biome.json): 2-space indent,
single quotes, no bracket spacing, organize-imports, recommended lint
rules (with a few project-specific rules disabled where they clash with
the strict tsconfig or Ink/React patterns). Adds 'lint' and 'format'
npm scripts and a dedicated lint job in CI.

The large diff is the one-time 'biome check --write' format pass over
the existing codebase. Two lint fixes beyond formatting: a string-concat
-> template literal in db/list.tsx, and an empty destructure pattern in
wp.tsx.

Rebuilt on current main (post kiqr#11-kiqr#16) to resolve merge conflicts.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
kjellberg pushed a commit that referenced this pull request Jun 7, 2026
Adds @biomejs/biome with a project config (biome.json): 2-space indent,
single quotes, no bracket spacing, organize-imports, recommended lint
rules (with a few project-specific rules disabled where they clash with
the strict tsconfig or Ink/React patterns). Adds 'lint' and 'format'
npm scripts and a dedicated lint job in CI.

The large diff is the one-time 'biome check --write' format pass over
the existing codebase. Two lint fixes beyond formatting: a string-concat
-> template literal in db/list.tsx, and an empty destructure pattern in
wp.tsx.

Rebuilt on current main (post #11-#16) to resolve merge conflicts.

Co-authored-by: kjellbergzoey <kjellbergzoey@users.noreply.github.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants