Skip to content

[Test] Ensure Ubuntu (Unix) Compatibility for Contributors #309

@shahnami

Description

@shahnami

We need to verify that the service works seamlessly on Ubuntu (or similar Unix environments), specifically from a contributor experience perspective. Most of the current development has been done on macOS, and we want to ensure:

  • The project compiles successfully on Ubuntu.
  • Developer tooling such as pre-commit hooks, OpenSSL/Cargo dependencies, and other system-level requirements behave as expected.

This helps avoid friction for new contributors (especially Linux users) when raising PRs or running development workflows locally.

What to Test:

  • Clone the repository on a clean Ubuntu machine;
  • Run cargo build and ensure there are no OpenSSL or toolchain-related issues;
  • Install and run pre-commit hooks;
  • Validate whether any pre-commit hooks fail unexpectedly (e.g. line endings, formatters, etc);
  • Check for any missing dependencies (e.g. libssl-dev, pkg-config) that should be added to README.md or a setup script.

Suggested Fixes

  • Update the documentation (CONTRIBUTING.md or README.md) with required setup steps.
  • Create a .sh or .md file listing all Ubuntu-specific setup instructions.
  • Consider adjusting the pre-commit config or adding OS-specific guidance.

Metadata

Metadata

Assignees

Labels

D-easyBeginner-friendly tasks.P-mediumImportant but not urgentS-needs-triageRequires initial triage or categorizationT-taskGeneral tasks or chores (e.g., refactoring, cleanup)cla: allowlistgood-first-issueBeginner-friendly, low-complexity issues to help new contributorshelp-wantedIssues where community contributions are welcome

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions