Contributing

Development Setup

Prerequisites: Node.js 18+ and npm.

git clone https://github.com/cheloei/ZTracer.git
cd ZTracer
npm install

Project Structure

ZTracer/
├── src/                 # Source code (TypeScript)
│   ├── index.ts         # Entry point
│   ├── ZTracer.ts          # Main class
│   ├── Type.ts          # Type definitions
│   └── modules/         # Utilities
├── dist/                # Compiled output (ESM + CJS)
├── example/             # Usage examples
└── docs/                # Documentation site

See Runtime & Styling for module details.

Build Commands

• npm run build — compiles TypeScript to dist/esm and dist/cjs.
• npm run pack — runs build then creates a .tgz package.

# After making changes:
npm run build

# Test locally:
cd example
npm install ../ZTracer-1.0.0.tgz
npm run node

Testing

Currently, ZTracer does not have automated tests. Manual testing is done via the example/ project:

1. Run npm run build in the root.
2. Navigate to example/ and run npm install ../ZTracer-1.0.0.tgz.
3. Test in Node.js: npm run node.
4. Test in the browser: npm run serve.

Contributions adding automated tests are welcome!

Pull Requests

1. Fork the repository.
2. Create a branch: git checkout -b feature/your-feature.
3. Make changes and commit with a clear message.
4. Push to your fork.
5. Open a Pull Request against the main branch.

For detailed guidelines, see the full contributing guide.