Skip to content

Contributing ​

Bug reports, fixes, docs and new provider adapters are all welcome. For a larger change, open an issue first so we can agree on the approach before you write the code. Everyone taking part agrees to the Code of Conduct. Security problems go to security@codevibe.in, not to the issue tracker.

Setup ​

You need Node 20 or later and pnpm 10 (corepack enable picks the version from package.json).

sh
git clone https://github.com/codevibe-technology/codevibe-sign.git
cd codevibe-sign
pnpm install
pnpm build

Packages import each other through their built output, so run pnpm build once before tests or type checks, and again after changing a package another one depends on.

Commands ​

CommandWhat it does
pnpm buildBuilds every package with tsup (ESM, CJS, types).
pnpm testRuns every package's vitest suite.
pnpm typecheckRuns tsc --noEmit in every package.
pnpm lintESLint over the repository.
pnpm format / pnpm format:checkPrettier.
pnpm --filter <package> testOne package, for example @codevibe_technology/sign-core.
pnpm --filter site devThis documentation site, with live reload.
pnpm changesetAdds a release note for your change.

Making a change ​

  • Core is pure: no I/O, only ports.
  • Keep each package's public API in its src/index.ts. Throw SignError with a stable code.
  • Tests are required, next to the code as *.test.ts. Cover the rules and the failure paths. Never commit real documents, keys or personal data.
  • New runtime dependencies must be well maintained and permissively licensed (MIT, Apache-2.0, BSD or ISC), pinned to an exact version, and justified in the pull request.

Commit messages ​

Conventional Commits:

feat(core): add sequential routing
fix(pdf): keep field boxes inside the page
docs(server): document the webhook retry policy

Write the subject in lower case and the imperative, without a full stop, in 72 characters or fewer.

Pull requests ​

Keep each pull request to one concern. CI runs lint, format check, build, type check and tests on Node 20 and 22. A maintainer reviews every pull request, and changes to sealing, verification, authentication or the audit log get a second review.

By contributing you agree that your contributions are licensed under the licence of the part you change: Apache-2.0 for the libraries, AGPL-3.0-only for packages/server and the apps (see LICENSING.md). Changes to the server or the apps may also need a short contributor licence agreement, which we will link here before we accept outside pull requests to those parts.

Libraries under Apache-2.0, server and apps under AGPL-3.0. "Codevibe", "Codevibe Sign" and "Hrvibe" are trademarks of Codevibe Technology and are not covered by the licences.