Uploaded image for project: 'Google Code-in'
  1. Google Code-in
  2. GCI-13

Add detailed README files to selected OpenMRS modules

    XMLWordPrintable

    Details

      Description

      It was found that the source code for a number of OpenMRS modules lack detailed README files. This is unfortunate, as without it, users will have to search for information on these modules online.
      Your task is to write a short README file for a module selected from the list below, and submit a pull request with the updated information.
      A list of these modules can be found below:

      https://github.com/openmrs/openmrs-module-coreapps
      https://github.com/openmrs/openmrs-module-auditlog
      https://github.com/openmrs/openmrs-module-webservices.rest
      https://github.com/openmrs/openmrs-module-allergyapi
      https://github.com/openmrs/openmrs-module-htmlformentryui
      https://github.com/openmrs/openmrs-module-xforms
      https://github.com/openmrs/openmrs-module-uiframework
      https://github.com/openmrs/openmrs-module-uicommons
      https://github.com/openmrs/openmrs-module-appointmentschedulingui
      https://github.com/openmrs/openmrs-module-sync
      https://github.com/openmrs/openmrs-module-emrapi

      1) Setup the OpenMRS developer environment on your local machine [0]
      2) Select one of the modules from above list, and document your selection on this ticket so that others do not claim the same module.
      2) Fork and checkout the Source code for the module you selected
      3) Write a detailed README section based on the module description information found on our wiki
      The readme file should contain the following details wherever applicable.

      • Wiki Link:
        -Installation guide/User Guide:
        -Technical documentation:
        -Unresolved issues for this module search link:

      4) Make pull request with the new README file

      [0] https://wiki.openmrs.org/display/docs/Step+by+Step+Installation+for+Developers

        Gliffy Diagrams

          Attachments

            Activity

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              surangak Suranga Kasthurirathne
              Votes:
              0 Vote for this issue
              Watchers:
              9 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - 1 day
                  1d
                  Remaining:
                  Remaining Estimate - 1 day
                  1d
                  Logged:
                  Time Spent - Not Specified
                  Not Specified