Add OSS essentials: README, LICENSE, CONTRIBUTING, and metadata#5
Add OSS essentials: README, LICENSE, CONTRIBUTING, and metadata#5
Conversation
- Add README.md with usage examples and design principles - Add MIT LICENSE - Add CONTRIBUTING.md with development setup guide - Add OSS metadata to package.json (keywords, author, repository, engines) - Add prepublishOnly script to ensure build before publish - Expand .gitignore with OS, editor, env, and coverage patterns
There was a problem hiding this comment.
Pull request overview
Adds OSS/repository “essentials” (docs + licensing + npm metadata) to make the project easier to understand, contribute to, and publish as a package.
Changes:
- Added README, LICENSE (MIT), and CONTRIBUTING guidelines
- Expanded
package.jsonwith npm metadata and aprepublishOnlybuild step - Extended
.gitignorewith common OS/editor/env/coverage entries
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
package.json |
Adds publish/build guardrails and npm package metadata (keywords, repo links, engines). |
README.md |
Introduces user-facing documentation (purpose, install, usage, options, design principles). |
LICENSE |
Adds MIT license text. |
CONTRIBUTING.md |
Documents local dev workflow, scripts, style, and PR guidelines. |
.gitignore |
Adds common ignores for OS/editor files, env files, and coverage output. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Option | Description | | ||
| |---|---| | ||
| | `--dry-run` | Fetch and output script without review | | ||
| | `--` | Separator between lgtmit options and the fetch command | |
There was a problem hiding this comment.
The Markdown table has an extra leading | (written as || ...), which renders as an unintended empty first column on GitHub. Use the standard table syntax with a single leading/trailing | for each row.
| npm install -g lgtmit | ||
| ``` | ||
|
|
||
| Requires [Claude CLI](https://docs.anthropic.com/en/docs/claude-cli) (`claude`) to be installed and authenticated. |
There was a problem hiding this comment.
This link points to the Claude CLI docs (/claude-cli), but the implementation uses claude -p and references Claude Code docs (/claude-code) in error messages. Update the link/text so it matches the actual required tool and documentation.
| | Command | Description | | ||
| |---|---| | ||
| | `npm run build` | Compile TypeScript to `dist/` | | ||
| | `npm run dev` | Watch mode for development | | ||
| | `npm test` | Run unit tests | | ||
|
|
There was a problem hiding this comment.
The Markdown table has an extra leading | (written as || ...), which renders as an unintended empty first column on GitHub. Use the standard table syntax with a single leading/trailing | for each row.
| ## Requirements | ||
|
|
||
| - Node.js 18+ | ||
| - [Claude CLI](https://docs.anthropic.com/en/docs/claude-cli) installed and authenticated |
There was a problem hiding this comment.
This requirement links to the Claude CLI docs (/claude-cli), but the implementation uses claude -p and references Claude Code docs (/claude-code). Update the link/text so it matches the actual required tool and documentation.
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
Claude CLI → Claude Code to match the actual tool used (claude -p)
Summary
Test plan
npx tsc --noEmitが通ることnpm run buildが通ること