Update documentation and CI configuration:

upgrade to Node.js 22
refine Docker setup
enhance benchmarking
improve contribution guidelines

Author: irzix

.dockerignore

@@ -4,11 +4,18 @@ dist
 .gitignore
 .env
 .env.local
+.env.example
 *.log
 .DS_Store
 coverage
 .idea
 .vscode
+.windsurf
 README.md
+CONTRIBUTING.md
+LICENSE
 docker-compose.yml
 eslint.config.js
+vitest.config.ts
+src/bench.ts
+src/__tests__

.env.example

@@ -0,0 +1,19 @@
+# Server
+PORT=3000
+HOST=0.0.0.0
+NODE_ENV=development
+
+# CORS
+CORS_ORIGIN=*
+
+# Rate Limiting
+RATE_LIMIT_MAX=100
+RATE_LIMIT_WINDOW=1 minute
+
+# NATS
+NATS_SERVERS=nats://localhost:4222
+NATS_RECONNECT_TIME_WAIT=2000
+NATS_MAX_RECONNECT_ATTEMPTS=10
+
+# Logging
+LOG_LEVEL=debug

.github/workflows/ci.yml

@@ -2,9 +2,9 @@ name: CI
 
 on:
   push:
-    branches: [ main, master ]
+    branches: [main]
   pull_request:
-    branches: [ main, master ]
+    branches: [main]
 
 jobs:
   test:
@@ -18,24 +18,23 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      
+
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: '20'
+          node-version: '22'
           cache: 'npm'
-      
+
       - name: Install dependencies
-        run: |
-          npm ci || (echo "package-lock.json out of sync, running npm install..." && npm install)
-      
-      - name: Run linter
+        run: npm ci
+
+      - name: Lint
         run: npm run lint
-      
+
       - name: Build
         run: npm run build
-      
-      - name: Run tests
+
+      - name: Test
         run: npm test
         env:
           NATS_SERVERS: nats://localhost:4222

.nvmrc

@@ -1 +1 @@
-20
+22

CONTRIBUTING.md

@@ -1,20 +1,12 @@
 # Contributing
 
-Thank you for considering contributing to this project! We welcome contributions of all kinds.
+Contributions are welcome! Whether it's a bug fix, new feature, documentation improvement, or benchmark result — we appreciate your help.
 
-## How to Contribute
+## Getting Started
 
-1. Fork the repository
-2. Create your feature branch (`git checkout -b feature/amazing-feature`)
-3. Commit your changes (`git commit -m 'Add some amazing feature'`)
-4. Push to the branch (`git push origin feature/amazing-feature`)
-5. Open a Pull Request
-
-## Development Setup
-
-1. Clone your fork:
+1. Fork and clone:
 ```bash
-git clone https://github.com/your-username/fastify-microservice-starter-ts.git
+git clone https://github.com/<your-username>/fastify-microservice-starter-ts.git
 cd fastify-microservice-starter-ts
 ```
 
@@ -23,34 +15,52 @@ cd fastify-microservice-starter-ts
 npm install
 ```
 
-3. Start NATS server:
+3. Start NATS:
 ```bash
-docker-compose up nats -d
+docker compose up nats -d
 ```
 
-4. Run in development mode:
+4. Run dev server:
 ```bash
 npm run dev
 ```
 
-## Code Style
+## Workflow
+
+1. Create a feature branch: `git checkout -b feature/my-feature`
+2. Make your changes
+3. Run checks:
+```bash
+npm run lint
+npm run build
+npm test
+```
+4. Commit with a clear message
+5. Push and open a Pull Request
+
+## Guidelines
 
-- Follow the existing code style
-- Run `npm run lint` before committing
-- Use TypeScript for all new code
-- Write meaningful commit messages
+- **TypeScript only** — all new code must be TypeScript with ESM imports (`.js` extensions)
+- **Keep it lean** — avoid adding unnecessary dependencies
+- **Test your changes** — add or update tests in `src/__tests__/`
+- **Follow existing patterns** — match the code style already in the project
+- **Run lint** — `npm run lint` must pass with no errors
 
-## Testing
+## Ideas for Contributions
 
-- Add tests for new features
-- Ensure all tests pass: `npm test`
-- Ensure the build succeeds: `npm run build`
+- Additional NATS patterns (JetStream, key-value store)
+- Schema validation examples (Fastify JSON Schema or Zod)
+- OpenTelemetry / tracing integration
+- More benchmark scenarios
+- Documentation improvements
+- Bug fixes and performance improvements
 
-## Pull Request Process
+## Pull Request Checklist
 
-1. Update the README.md if needed
-2. Ensure your code follows the project's style guidelines
-3. Make sure all tests pass
-4. Request review from maintainers
+- [ ] Code follows the project style
+- [ ] Tests added/updated and passing
+- [ ] Build succeeds (`npm run build`)
+- [ ] Lint passes (`npm run lint`)
+- [ ] README updated if needed
 
 Thank you for contributing!

Dockerfile

@@ -1,21 +1,19 @@
-FROM node:20-alpine AS builder
+FROM node:22-alpine AS builder
 
 WORKDIR /app
 
-COPY package*.json ./
-COPY tsconfig.json ./
-
+COPY package*.json tsconfig.json ./
 RUN npm ci
 
 COPY src ./src
 RUN npm run build
 
-FROM node:20-alpine
+FROM node:22-alpine
 
 WORKDIR /app
 
 COPY package*.json ./
-RUN npm ci --only=production
+RUN npm ci --omit=dev
 
 COPY --from=builder /app/dist ./dist