docs: README badges + ToC; add typecheck CI and PR template #58
Conversation
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
…echeck script and CI; chore: add PR template; fix: type definitions for logger and Node
docs: README badges + ToC; add typecheck CI and PR template
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary: Improve onboarding and repo clarity with a cleaner README (badges, Table of Contents, docs links), add a minimal CI workflow to run TypeScript typecheck, and introduce a pull request template for consistent contributions.
Motivation: Make the project easier to evaluate at a glance, reduce friction for new contributors, and catch basic typing issues automatically.
Changes
README: badges (CI, License, X), compact ToC, “Docs” section, fixed clone URL, quick typecheck step.
Tooling: added typecheck script; added typescript and @types/node; tsconfig.json includes Node types.
CI: new GitHub Actions workflow running npm run typecheck on push/PR.
PR hygiene: new .github/PULL_REQUEST_TEMPLATE.md.
Types: allow optional confidence in utils/logger.ts so agent emissions typecheck.
Testing
Ran npm ci and npm run typecheck locally — passing.
CI will run typecheck on this PR.