This is an old revision of the document!
OHDSI open-source development best practices (DRAFT)
Contributors: Anthony Sena, Chris Knoll, Frank DeFalco, Peter Rijnbeek
For reference, we reviewed some common release/code management articles such as Gitflow and alternatives to form the basis of this article. The goal with this approach was to keep the code management process as simple as possible while leveraging the functionality available in Git and GitHub. We've also formally adopted the semantic versioning scheme for all software which is already in practice in most of the OHDSI code repositories.
This article assumes you have familiarity with Git and GitHub. If you do not, here is a nice collection of guides to get you started:
For the purposes of this article, we assume that you have installed Git and have access to a Git repository. You can set up your own Git repository to follow along with the examples in this article. As a note, all of the code in this article is using the Git command line on Windows. There should be no material difference between running Git commands on Windows versus another operating system but if you do experience any problems please report them on the OHDSI forum:
The following section is described how to work with source code in a Git repository. It provides a general overview of using Git and explains how to provide code contributions. Subsequently, the Release Management section will focus on best practices and conventions for controlling versions and releases of the source code in a repository.