Thank you for your interest in contributing. This document explains the process and requirements.
- Check existing issues to see if someone is already working on what you want to change.
- Open an issue first for significant changes (new modules, API changes, architecture). Small fixes and documentation improvements can go straight to a PR.
- Read the Code of Conduct if one exists.
Every contribution must satisfy two legal requirements:
All commits must include a Signed-off-by trailer certifying that you have the right to submit the code. Add it with:
git commit --signoff -m "your commit message"This adds a line like:
Signed-off-by: Your Name <your@email.com>
The DCO bot will check every commit in your PR. If any commit is missing the trailer, the bot will comment with instructions.
First-time contributors must sign a CLA. This grants the project a license to use your contribution and protects both you and the project.
Individual contributors: Sign the Individual CLA by commenting on your first PR with:
I have read the CLA Document and I hereby sign the CLA.
The CLA bot will record your signature automatically. You only need to do this once across all repositories maintained by igorjs.
Corporate contributors: If you are contributing on behalf of your employer, your organisation must sign the Corporate CLA. Email the signed document to oss@mail.igorjs.io. Individual employees listed as Designated Employees do not need to sign the Individual CLA separately.
git clone https://github.com/igorjs/pure-fx.git
cd pure-fx
pnpm installpnpm run lint # biome check
pnpm run check # type-check (tsgo)
pnpm run build # build to dist/
pnpm test # unit tests (pure-test)
pnpm run test:types # type-level testsThe repository has git hooks that run automatically:
- Pre-commit: Adds SPDX license headers to new
.tsfiles if missing. - Pre-push: Runs license header check, lint, type-check, build, and tests. Push is blocked if any check fails.
- All source files must start with
// Copyright 2026 igorjs. SPDX-License-Identifier: Apache-2.0 - Follow existing patterns: public interfaces, private impl classes, const/type merge for namespaces
- Use
ResultandOptioninstead of exceptions - Zero runtime dependencies. Always.
- All new modules must work on Node and Bun. Runtime-specific code goes in adapters.
- Unit tests use
node:testand live intests/ - Integration tests are runtime-agnostic
.mjsfiles that run on Node, Bun, Workers, and Browser - New features need both unit tests and integration test coverage
- Run
node tests/smoke-all.mjsandbun tests/smoke-all.mjsto verify cross-runtime compatibility
Use Conventional Commits:
feat(core): add Validation module
fix(runtime): wire up Bun memoryUsage
docs: update FFI troubleshooting guide
test: add HashMap integration tests
Always sign commits: git commit --signoff --gpg-sign
- Fork the repository and create a branch from
main. - Make your changes with tests.
- Ensure all checks pass:
pnpm run lint && pnpm run check && pnpm run build && pnpm test - Sign the CLA (first-time only).
- Submit a PR with a clear description of what and why.
- Address review feedback.
Open a GitHub issue with:
- Runtime and version (Node 24, Bun 1.3, etc.)
- Minimal reproduction code
- Expected vs actual behavior
- Error messages (full stack trace)
Do not open a public issue for security vulnerabilities. See SECURITY.md for responsible disclosure instructions.
By contributing, you agree that your contributions will be licensed under the Apache License 2.0, subject to the terms of the CLA.