Skip to content

Contributing Code

This guide covers the process of contributing code to MedUX.

Getting Started

  1. Set up your development environment — follow the Developer Setup guide.
  2. Read the code conventions — see Code Conventions.
  3. Find an issue to work on, or open a new one to discuss your idea on the GitLab issue tracker.

Workflow

  1. Fork the repository on GitLab
  2. Create a feature branch from main
  3. Make your changes
  4. Write or update tests
  5. Run the test suite (venv active): pytest
  6. Run the linter (venv active): pre-commit run --all-files
  7. Submit a merge request

Guidelines

  • Follow the code conventions
  • Write tests for new functionality
  • Update documentation for user-visible changes
  • Keep commits focused and well-described
  • All tests must pass before submitting a merge request

Technology Stack

MedUX is built with:

  • Python 3.13+ and Django 6.0+
  • GDAPS for the plugin architecture
  • Conjunto for the UI framework
  • HTMX for server-driven interactivity
  • Tabler.io (Bootstrap 5) for styling
  • uv for package management

See the Developer Guide for detailed documentation on each of these components.