-
Notifications
You must be signed in to change notification settings - Fork 0
Init setup of project #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Initial project scaffolding establishing TypeScript source, testing (Vitest), linting (ESLint + Prettier), CI workflow, and documentation. Key changes introduce sample functions (greet, add) with tests, coverage configuration, and development tooling (husky, dependabot).
- Added core source and test files (greet, add with unit tests)
- Configured tooling: Vitest, ESLint flat config, Prettier, GitHub Actions CI
- Added extensive project documentation and contributor guidelines
Reviewed Changes
Copilot reviewed 18 out of 20 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| vitest.config.ts | Adds Vitest configuration including coverage setup |
| src/index.ts | Introduces initial exported functions (greet, add) |
| src/index.test.ts | Provides unit tests for sample functions |
| package.json | Defines project metadata, scripts, and dev dependencies |
| eslint.config.js | Sets up ESLint flat config with TypeScript rules |
| README.md | Adds full project documentation and usage examples |
| CHANGELOG.md | Establishes changelog with initial entries |
| .vscode/settings.json | Workspace editor settings for consistency |
| .vscode/extensions.json | Recommended VSCode extensions list |
| .prettierrc | Prettier formatting configuration |
| .prettierignore | Ignore patterns for formatting |
| .nvmrc | Specifies Node.js version (22) |
| .npmignore | Package publish ignore rules |
| .husky/pre-commit | Pre-commit hook invoking lint-staged |
| .github/workflows/ci.yml | CI pipeline across multiple Node versions |
| .github/dependabot.yml | Dependabot update configuration |
| .github/copilot-instructions.md | Internal project guidance for Copilot usage |
| .editorconfig | Editor configuration for cross-editor consistency |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This pull request sets up the initial foundation for the Outport project, establishing its tooling, configuration, and development standards. It introduces TypeScript with strict settings, comprehensive testing and linting, automated CI/CD, and documentation. The project includes sample functions (
greetandadd) with full test coverage. Below are the most important changes grouped by theme.