Skip to content

Commit 5bdc7ea

Browse files
author
Christopher Skene
committed
documentation update
1 parent 6024930 commit 5bdc7ea

6 files changed

Lines changed: 276 additions & 60 deletions

File tree

‎CODE_OF_CONDUCT.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
## Contributor Covenant Code of Conduct
2+
3+
This project adopts the Contributor Covenant Code of Conduct, version 2.1.
4+
5+
## Our Pledge
6+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
7+
8+
## Our Standards
9+
Examples of behavior that contributes to a positive environment for our community include:
10+
- Demonstrating empathy and kindness toward other people
11+
- Being respectful of differing opinions, viewpoints, and experiences
12+
- Giving and gracefully accepting constructive feedback
13+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
14+
- Focusing on what is best not just for us as individuals, but for the overall community
15+
16+
Examples of unacceptable behavior include:
17+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
18+
- Trolling, insulting or derogatory comments, and personal or political attacks
19+
- Public or private harassment
20+
- Publishing others’ private information, such as a physical or email address, without their explicit permission
21+
- Other conduct which could reasonably be considered inappropriate in a professional setting
22+
23+
## Enforcement Responsibilities
24+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior they deem inappropriate, threatening, offensive, or harmful.
25+
26+
## Scope
27+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces.
28+
29+
## Enforcement
30+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team at support@aurabox.cloud. All complaints will be reviewed and investigated promptly and fairly.
31+
32+
## Enforcement Guidelines
33+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
34+
35+
## 1. Correction
36+
- Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
37+
- Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
38+
39+
## 2. Warning
40+
- Community Impact: A violation through a single incident or series of actions.
41+
- Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
42+
43+
## 3. Temporary Ban
44+
- Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
45+
- Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
46+
47+
## 4. Permanent Ban
48+
- Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
49+
- Consequence: A permanent ban from any sort of public interaction within the community.
50+
51+
## Attribution
52+
This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
53+
54+
Community Impact Guidelines were inspired by https://github.com/mozilla/diversity
55+
56+
For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Contributing to Harmony Proxy
2+
3+
Thank you for your interest in contributing! This document explains how to propose changes, the development workflow, coding standards, and community expectations.
4+
5+
## Code of Conduct
6+
- By participating, you agree to abide by our Code of Conduct. See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
7+
8+
## Scope of contributions
9+
- We welcome bug reports, feature requests, documentation improvements, performance optimizations, and test coverage enhancements.
10+
11+
## Getting started
12+
- Read [DEVELOPER.md](DEVELOPER.md) for local setup, repository layout, commands, and testing guidance.
13+
- Review the docs index at [docs/README.md](docs/README.md) for architecture, configuration, middleware, and testing references.
14+
15+
## Workflow
16+
- Trunk-based development: use feature branches and open pull requests against main.
17+
- Keep PRs small and focused. Avoid mixing unrelated refactors, formatting, or lint changes with functional changes.
18+
- Link issues in PR descriptions when applicable. Describe the problem, approach, and trade-offs.
19+
20+
## Commit messages and PR titles
21+
- Use Conventional Commits and prefer aligning PR titles similarly:
22+
- feat: add DIMSE store-and-forward support
23+
- fix: handle JWKS rotation error on startup
24+
- docs: update configuration examples
25+
- refactor: extract DICOMweb client
26+
- test: add pipeline validation cases
27+
- perf: reduce clone in router
28+
- ci: enable tests in GitHub Actions
29+
- Follow Semantic Versioning. Breaking changes should be marked with ! (e.g., feat!: change endpoint config).
30+
31+
## Coding standards and gates
32+
- Format code: `cargo fmt --all`
33+
- Lint: `cargo clippy --all-targets -- -D warnings`
34+
- Build: `cargo build`
35+
- Test: `cargo test` (add `RUST_LOG=harmony=debug` and `-- --nocapture` for verbose output)
36+
- These gates must pass locally before opening a PR; CI will run them as well.
37+
38+
## Tests
39+
- Prefer focused and deterministic unit/integration tests.
40+
- Use ./tmp for temporary artifacts; do not rely on /tmp.
41+
- DIMSE/DCMTK integration tests:
42+
- Default runs are quiet. Enable verbose logs with `HARMONY_TEST_VERBOSE_DCMTK=1`.
43+
- Additional debug behavior: `HARMONY_TEST_DEBUG=1`.
44+
- Use the samples/ directory for test inputs where relevant; keep tests hermetic.
45+
46+
## Documentation
47+
- Update docs/ and examples/config when behavior or configuration changes.
48+
- Include usage notes and security implications where applicable.
49+
50+
## Security guidance
51+
- Do not commit secrets. Use environment variables or secret managers; restrict permissions to least privilege.
52+
- JWT in production should use RS256 with strict algorithm enforcement and claim validation (exp, nbf, iat, iss, aud).
53+
- Encryption: where used, AES-256-GCM with ephemeral public key, IV, and authentication tag encoded in base64.
54+
- Temporary files: prefer ./tmp within the working directory.
55+
- See [docs/security.md](docs/security.md) for additional guidance.
56+
57+
## Licensing of contributions
58+
- By contributing, you agree your contributions are licensed under the Apache License, Version 2.0, and acknowledge the project’s commercialization restriction described in [README.md](README.md) (hosted resale/embedding requires a commercial licence from Aurabox Pty Ltd).
59+
- No CLA or DCO is presently required.
60+
61+
## Issue triage and labels
62+
- Use labels such as bug, enhancement, documentation, help wanted, and good first issue where applicable.
63+
64+
## Contact
65+
- General questions, security or conduct concerns: hello@aurabox.cloud

‎DEVELOPER.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# DEVELOPER.md
2+
3+
## Overview
4+
- Harmony Proxy is a Rust workspace providing a configurable data mesh proxy/gateway for heterogeneous systems, with first-class healthcare protocols (FHIR, JMIX, DICOM/DICOMweb). It is part of the Runbeam ecosystem.
5+
- Key concepts: endpoints, middleware, services/backends, pipelines, and storage. See [docs/README.md](docs/README.md) for full architecture.
6+
7+
## Prerequisites
8+
- Rust (stable) via rustup
9+
- macOS or Linux
10+
- Optional: DCMTK tools for DIMSE integration tests (e.g., macOS: `brew install dcmtk`, Debian/Ubuntu: `sudo apt-get install dcmtk`)
11+
12+
## Repository layout
13+
- Root crate: harmony (src/lib.rs, src/main.rs)
14+
- Workspace crates: crates/dimse, crates/dicom_json_tool, crates/transform
15+
- Examples: examples/config (config.toml, pipelines/, transforms/), examples/custom_endpoint (example crate)
16+
- Docs: docs/* (getting-started, configuration, endpoints, middleware, backends, router, envelope, dimse-integration, testing, security, system-description)
17+
- Samples: samples/jolt/*; additional DICOM samples in dev/samples
18+
- Temporary outputs: prefer ./tmp (gitignored) over /tmp
19+
20+
## Build, run, test
21+
- Build (debug): `cargo build`
22+
- Build (release): `cargo build --release`
23+
- Run with example config: `cargo run -- --config examples/config/config.toml`
24+
- Run tests: `cargo test`
25+
- With logs: `RUST_LOG=harmony=debug cargo test -- --nocapture`
26+
- Format: `cargo fmt --all`
27+
- Lint: `cargo clippy --all-targets -- -D warnings`
28+
29+
## Configuration model (high level)
30+
- Config is loaded from the provided TOML file and can merge additional files from proxy.pipelines_path and proxy.transforms_path relative to the base config directory.
31+
- Major sections: proxy, network, pipelines, endpoints, backends, middleware/middleware_types, services, targets, storage, transforms.
32+
- Validation enforces: proxy ID and log level; per-network interface/HTTP constraints; pipeline endpoints exist; middleware_types are known or specified via module; targets have non-empty URLs; storage backend options are valid.
33+
- See: src/config/config.rs and [docs/configuration.md](docs/configuration.md).
34+
35+
## Pipelines and middleware
36+
- Pipelines bind networks to endpoints and an ordered set of middleware/services.
37+
- Built-in middleware types include: jwtauth, auth, connect, passthru, json_extractor, jmix_builder, dicomweb_to_dicom, dicom_to_dicomweb, dicomweb, transform.
38+
- JWT guidance: prefer RS256 in production, enforce algorithm, validate exp/nbf/iat, iss/aud as applicable. HS256 is for development/tests only.
39+
40+
## JMIX and schema path
41+
- The JMIX schema directory used by validation or transforms is configurable and may be placed outside the repo (e.g., ../jmix). Ensure paths in config reference your chosen location.
42+
43+
## Storage and tmp
44+
- Filesystem storage defaults to a project-local ./tmp directory. Favor ./tmp for all temporary files. The path may be configurable via storage options.
45+
46+
## Testing notes
47+
- Strategy: unit/integration tests should be fast and deterministic. See [docs/testing.md](docs/testing.md).
48+
- DIMSE integration: DCMTK processes may be spawned; artifacts are written under ./tmp with per-test UUIDs. Enable verbose DIMSE output with `HARMONY_TEST_VERBOSE_DCMTK=1`. Additional debugging: `HARMONY_TEST_DEBUG=1`.
49+
- Sample data: samples/ and dev/samples/ contain example inputs.
50+
51+
## Security considerations
52+
- Encryption: the project uses AES-256-GCM where applicable, with ephemeral public key, IV, and authentication tag encoded in base64.
53+
- Credentials and secrets: do not commit. Load via environment variables or secret managers. Prefer least-privilege file permissions.
54+
- JWT: in production, require RS256 with strict algorithm checks and claim validation.
55+
- Temporary files: prefer ./tmp within the working directory.
56+
- See [docs/security.md](docs/security.md) for more detail.
57+
58+
## Commit and PR hygiene
59+
- Use Conventional Commits for messages (e.g., feat:, fix:, docs:, refactor:, test:, build:, ci:, chore:, perf:, style:, revert:). Keep PRs focused; avoid mixing unrelated changes.
60+
- Trunk-based development: open feature branches targeting main.
61+
- Tests, lint, and fmt should pass locally before opening a PR.
62+
63+
## Quick links
64+
- README: [README.md](README.md)
65+
- Docs index: [docs/README.md](docs/README.md)
66+
- Getting started: [docs/getting-started.md](docs/getting-started.md)
67+
- Configuration: [docs/configuration.md](docs/configuration.md)
68+
- Middleware: [docs/middleware.md](docs/middleware.md)
69+
- Security: [docs/security.md](docs/security.md)
70+
- Testing: [docs/testing.md](docs/testing.md)
71+
- Router: [docs/router.md](docs/router.md)

‎docs/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Documentation Index
22

3-
Welcome to Harmony Proxy’s documentation. Start here to explore concepts, configuration, and usage.
3+
Welcome to Harmony Proxy’s documentation. Harmony is a general-purpose data mesh proxy with first-class support for medical data (FHIR, DICOM/DICOMweb, JMIX). Start here to explore concepts, configuration, and usage.
44

55
- Getting started: getting-started.md
66
- Configuration: configuration.md

0 commit comments

Comments
 (0)