Skip to content
Trademark Sentinel Docs

Contributing

Trademark Sentinel is open source under the MIT licence (see LICENSE at the repo root). Contributions of any size are welcome — bug fixes, docs, new sources, and feature work all go through the same PR flow.

The repository’s CONTRIBUTING.md (at the repo root) is the source of truth. This page summarises it and points at the surrounding docs.

Branch model

  • main is the integration branch. It is protected: no direct pushes, all changes land via PR with passing CI.
  • Use short-lived feature branches off main, named feat/<topic>, fix/<topic>, or chore/<topic>.
  • Open the PR early and keep it small. Rebase main into your branch (don’t merge) to keep history linear.
  • Squash-merge by default, unless preserving the branch’s commits genuinely helps a future reader.

Pulling open-saas updates

Trademark Sentinel is forked from wasp-lang/open-saas and tracks it via the upstream git remote. To pull periodic upstream changes:

Terminal window
git fetch upstream
git checkout -b chore/upstream-sync main
git merge upstream/main   # or rebase, depending on conflict shape
# resolve conflicts, run app/ build + parity tests, open PR

Upstream syncs go through the same PR + CI gate as any other change — never push a merge commit directly to main.

Commits

  • Use Conventional Commits where reasonable: feat:, fix:, chore:, docs:, test:, refactor:.
  • Keep commits scoped — don’t bundle unrelated changes.
  • Commit signing is not required at this stage. If we enable it later, CONTRIBUTING.md is updated first.

Tests and CI

  • Every change touching app/src/sources/ must keep the source-adapter parity tests passing (tests/parity/).
  • Add unit/integration tests alongside the change. CI must be green before merge.
  • See Test strategy (FUL-3) §6 for the test phase labels we apply to PRs and the gating rules.

Local development

  1. Read Prerequisites and install Node 24, Wasp 0.23, and Docker.
  2. Copy Environment variables defaults into app/.env.server and app/.env.client.
  3. From the repo root: cd app && wasp start. The dev client runs on http://localhost:3000, the server on http://localhost:3001.

The repo’s top-level README.md has the canonical quickstart — refer to it if anything here drifts.

Code of conduct

Be kind, assume good faith, focus on the change rather than the contributor. Repository-wide policy follows the standard contributor norms documented in CONTRIBUTING.md; a more formal CoC stub will be added if and when the project needs one.

References