Skip to content

Latest commit

 

History

History
77 lines (49 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

77 lines (49 loc) · 3.06 KB

Contributing In General

Our project gladly welcomes external contributions. To contribute code or documentation, please submit a pull request.

A good way to familiarize yourself with the codebase and contribution process is to look for and tackle low-hanging fruit in the issue tracker. Before embarking on a more ambitious contribution, please quickly get in touch with us. Also, be sure to take a look at the ZenHub to get the full view of the issues and roadmap.

Note: We appreciate your effort, and want to avoid a situation where a contribution requires extensive rework (by you or by us), sits in backlog for a long time, or cannot be accepted at all!

Proposing new features

If you would like to implement a new feature, please raise an issue before sending a pull request so the feature can be discussed. This is to avoid you wasting your valuable time working on a feature that the project developers are not interested in accepting into the code base.

Fixing bugs

If you would like to fix a bug, please raise an issue before sending a pull request so it can be tracked.

Merge approval

A pull request requires approval from at lesat two of the maintainers.

For a list of the maintainers, see the MAINTAINERS.md page.

Legal

Each source file must include a license header for the Apache Software License 2.0. Using the SPDX format is the simplest approach. e.g.

/*
 * (C) Copyright <holder> <year of first update>[, <year of last update>]
 *
 * SPDX-License-Identifier: Apache-2.0
 */

Communication

To connect with us, please open an issue or contact one of the maintainers via email. See the MAINTAINERS.md page.

Setup

The LinuxForHealth connect local development environment requires Python 3.8 or higher and Docker Desktop.

LinuxForHealth is currently built on:

Fast API and Pydantic for data ingress and validation.

Kafka and NATS for world-class data streaming and messaging.

Standard data formats, including ASC X12, C-CDA, DICOM, HL7 FHIR, and HL7 2.xwith easy extensiblity to support any format.

Instructions for developer setup can be found here.

Testing

To ensure a working environment, please run the project tests and the code formatter before submitting your pull request.

Coding guidelines

  1. Write tests. Pull Requests should include necessary updates to unit tests.

  2. Use docstrings.

  3. Keep the documentation up-to-date. Documentation updates require a pull request.

Leave the code better than you found it.

LinuxForHealth is sublicensed by the Linux Foundation with Sublicense ID: 20200615-0008