Uploaded image for project: 'FHIR Specification Feedback'
  1. FHIR Specification Feedback
  2. FHIR-42153

Links to lines of code on GitHub should be targeted to a commit or release

    XMLWordPrintableJSON

Details

    • Icon: Technical Correction Technical Correction
    • Resolution: Persuasive
    • Icon: Highest Highest

    Description

      The ModeInfo doc contains the following link for more information about the tooling:

      https://github.com/cqframework/cqf-tooling/blob/master/tooling/src/main/java/org/opencds/cqf/tooling/modelinfo/StructureDefinitionToModelInfo.java#L45

      Since this link is to the master branch, and not tied to a specific commit or release, it's not stable enough to be included in a specification. A change to the source code file on GitHub could render the link broken, irrelevant, or pointing to the wrong code.

      It would be better to either:

      • link to a specific commit or release and note that as the tools evolve users may need to find the documentation for the most recent release
      • or link just to the file (but not a specific line of code), which at least remains relevant as long as the file is not moved or removed.

      Attachments

        Activity

          People

            jen_seeman Jennifer Seeman
            cmoesel Chris Moesel
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: