Help the community improve HospitalRun.

Learn more about recommended skill-set, development resources and collaboration workspaces.

HospitalRun Required Skills

Recommended skill-set

In order to contribute to HospitalRun codebase, developers need:

  • Reasonable knowledge of Node.js and TypeScript
  • Some knowledge of Fastify for backend contributions
  • Basic knowledge of React for frontend contributions
  • Basic knowledge of how CouchDB and PouchDB work

Development resources

Everything you need to be a contributor member

Docs Slack GitHub Storybook

To setup the development toolchain we recommend the use of Visual Studio Code as IDE, nvm for the management of different versions of Node, and yarn for a fast, reliable, and secure dependency management (install it as a global package with npm i -g yarn). Furthermore, you need an GitHub account that has SSH access enabled.

HospitalRun Docs


HospitalRun is a community project. We invite your participation through financial contributions, issues, and pull requests!

Contributions are always welcome. Before contributing please read the code of conduct and search the issue tracker; your issue may have already been discussed or fixed in master. If you're new to the project, maybe you'd like to open a pull request to address one of good-first-issue.

To contribute, fork HospitalRun, commit your changes, and send a Pull Request.

Working on an Issue

In order to optimize the workflow and to prevent multiple contributors working on the same issue without interactions, a contributor must ask to be assigned to an issue by one of the core team members: it's enough to ask it inside the specific issue.

Feature Requests

Feature requests should be submitted in the issue tracker, with a description of the expected behavior & use case, where they’ll remain closed until sufficient interest, e.g. :+1: reactions, has been shown by the community. Before submitting a request, please search for similar ones in the closed issues.

Pull Requests

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Contributor License Agreement

HospitalRun is a member of the Open JS Foundation. As such, we request that all contributors sign our contributor license agreement (CLA).

For more information about CLAs, please check out Alex Russell’s excellent post, “Why Do I Need to Sign This?”.