Documentation

Pull request guide

Thank you for contributing to OpenDDE! This guide covers how to submit a pull request.

Before you start

Check the issue tracker for existing issues or feature requests
For large changes, open an issue first to discuss your approach
Fork the repository and create a feature branch

Branch naming

Use descriptive branch names:

feat/pocket-comparison-view
fix/ligand-table-sorting
docs/api-reference-update
refactor/engine-adapter-pattern

Commit messages

Follow conventional commit format:

feat: add pocket comparison view
fix: correct ligand table sorting by activity
docs: update API reference with new endpoints
refactor: extract engine adapter base class

PR checklist

Code compiles without errors (docker compose up --build succeeds)
New features have appropriate error handling
API changes are documented in the API reference
No secrets or API keys are committed
UI changes are responsive (tested at mobile and desktop widths)

Review process

Submit your PR with a clear description of the change and why
A maintainer will review within 48 hours
Address any feedback and push additional commits
Once approved, the PR will be squash-merged into main

Good areas to contribute

New engines — Integrate additional computational tools
Visualization — Improve 3D viewer features or charts
Documentation — Expand guides, add tutorials
Testing — Add unit and integration tests
Accessibility — Improve keyboard navigation and screen reader support

Back to introduction →