MotivdMotivd
AboutCase studiesDocs
PricingSecurity
← Back to Documentation

Contributing

Standards, workflow, testing, and PR expectations

On this page

  • Contributing
    • Contribution principles
    • Local workflow
    • Quality standards
    • Testing expectations
    • Git and commit workflow
    • Pull request and review checklist
    • Security and data handling

Contributing

How to contribute changes that are reliable, reviewable, and production-ready.

Contribution principles

Every contribution should:

  • Improve user outcomes on the idea → live product path
  • Preserve multilingual quality (English + French routes)
  • Maintain clear ownership and deployability for users
  • Keep documentation aligned with behavior

Aim for small, high-signal changes that are easy to review.

Local workflow

1) Understand the current behavior

  • Reproduce the issue or verify the feature gap first.
  • Read the relevant route/component/API implementation before editing.
  • Confirm whether related docs or tests already exist.

2) Implement with clear scope

  • Make the minimal set of changes needed to solve the problem.
  • Reuse existing patterns and components where possible.
  • Keep copy and UX consistent with founder-first language.

3) Validate locally

  • Run build checks: npm run build
  • Run relevant tests (e2e/unit as appropriate)
  • Manually verify changed UI flows

Quality standards

Code quality

  • Prefer readable, maintainable code over clever shortcuts.
  • Keep components modular and avoid unnecessary coupling.
  • Add concise comments only when logic is non-obvious.

Product quality

  • Preserve PRD alignment and builder flow clarity.
  • Protect user trust (auth/security/privacy-sensitive paths).
  • Keep SEO and i18n expectations intact for every new route.

Documentation quality

  • Update docs whenever behavior, routes, APIs, or operational flow changes.
  • Keep the docs hub, section pages, and sitemap entries synchronized.

Testing expectations

At minimum, contributors should:

  1. Ensure the project builds successfully.
  2. Add or update tests for behavior that changed.
  3. Run the relevant test scope locally.
  4. Re-check affected flows in both locales when user-facing routes changed.

Prefer regression-oriented tests for previously fixed bugs.

Git and commit workflow

  • Use focused commits with descriptive messages.
  • Keep one logical change per commit whenever possible.
  • Push commits to GitHub after validation.

Good commit examples:

  • feat(docs): add api deployment and contributing sections
  • fix(builder): preserve job id from poll responses
  • test(e2e): extend docs route smoke coverage

Pull request and review checklist

Before requesting review, verify:

  • Behavior is implemented and validated locally
  • EN/FR routes are supported where required
  • Sitemap/docs references are updated for new pages
  • Documentation reflects the current behavior
  • Tests were added/updated for meaningful coverage
  • No unrelated changes were included

Security and data handling

  • Never commit secrets or credentials.
  • Keep service-role keys and private tokens server-side only.
  • Treat webhook payloads and external API responses as untrusted input.
  • Follow least-privilege principles for third-party integrations.